1350 OMS CLI Reference 8DG42097JAAA

Title page
1350 OMS 9.1.1

CLI Reference
8DG42097JAAA
ISSUE 1
MARCH 2011
Legal notice
Legal notice
Alcatel, Lucent, Alcatel-Lucent and the Alcatel-Lucent logo are trademarks of Alcatel-Lucent. All other trademarks are the property of their respective
owners.
The information presented is subject to change without notice. Alcatel-Lucent assumes no responsibility for inaccuracies contained herein.
Copyright © 2011 Alcatel-Lucent. All rights reserved.
Notice
Every effort was made to ensure that the information in this document was complete and accurate at the time of printing. However, information is subject to
change.
Warranty
Alcatel-Lucent provides a limited warranty for this product. For more information, consult your local Alcatel-Lucent customer support team.
Ordering information
The ordering number for this document is 8DG42097JAAA. To order 1350 OMS information products, contact your local Alcatel-Lucent customer support
team.
Technical support
For technical support, contact your local customer service support team. You can reach them via the Web at the Alcatel-Lucent Customer Support web site
(http://www.alcatel-lucent.com/support) or the customer support telephone number listed at the Alcatel-Lucent Contact Us web site (http://www.alcatel-
lucent.com/contact).
Information product support
For questions or concerns about this or any other Alcatel-Lucent information product, please contact us at one of the following numbers: (888) 727 3615 (for
the continental United States) · +1 (630) 713 5000 (for all countries).
Contents
About this document

Purpose ............................................................................................................................................................................................. ix
ix
Reason for revision ...................................................................................................................................................................... ix

ix
Safety information ........................................................................................................................................................................ ix

ix
Intended audience ......................................................................................................................................................................... ix

ix
How to use this information product ..................................................................................................................................... ix
Conventions used .......................................................................................................................................................................... xi

xi
Related documentation ............................................................................................................................................................... xi

xi
How to order ................................................................................................................................................................................ xiii

xiii
How to comment ........................................................................................................................................................................ xiii

xiii
1 Overview
Overview ...................................................................................................................................................................................... 1-1

1-1
1350 OMS Overview ............................................................................................................................................................... 1-2

1-2
1350 OMS Modules for System Resiliency and Northbound Communication ................................................. 1-6
1-6
Command Description ............................................................................................................................................................ 1-7

1-7
2 Common Command Verbs
Overview ...................................................................................................................................................................................... 2-1

2-1
PRINT, SLEEP, and EXIT Commands ............................................................................................................................. 2-2

2-2
CHOWNonObj and ACT_UPDATE Commands .......................................................................................................... 2-3

2-3
SET Commands ......................................................................................................................................................................... 2-4

2-4
MOVE and MULTISET Commands ................................................................................................................................. 2-5

2-5
CONFIGURE Command ....................................................................................................................................................... 2-7

2-7
....................................................................................................................................................................................................................................
8DG42097JAAA Issue 1 iii
March 2011
Contents
....................................................................................................................................................................................................................................
SYNCHRONIZE CLASS eml/ne ....................................................................................................................................... 2-9
2-9
CONSISTENCY Command ............................................................................................................................................... 2-10

2-10
NT MNGPdhAlr ..................................................................................................................................................................... 2-11

2-11
3 Path Management
Overview ...................................................................................................................................................................................... 3-1

3-1
Path Management ..................................................................................................................................................................... 3-2

3-2
Path Management: SET and UPDATE ............................................................................................................................. 3-3

3-3
Path Management: CREATE and DELETE .................................................................................................................... 3-5

3-5
Path Management: CONSTR, REROUTE, and UNDOREROUTE ...................................................................... 3-6

3-6
Path Management: ALLOC and DEALLOC .................................................................................................................. 3-8

3-8
Path Management: IMPL and DEIMPL ........................................................................................................................... 3-9

3-9
Path Management: PROTECT .......................................................................................................................................... 3-10

3-10
Path Management: ADDLEG and REMOVELEG .................................................................................................... 3-12

3-12
Path Management: COMMISSION and UNCOMMISSION ................................................................................ 3-13

3-13
Path Management: SPLIT and JOIN ............................................................................................................................... 3-14

3-14
Path Management: CONNECT and DISCONNECT ................................................................................................ 3-15

3-15
Path Management: Various Updates ................................................................................................................................ 3-16

3-16
SAVEROUTE/RECALLROUTEpath/trail ................................................................................................................... 3-17

3-17
Path Examples ......................................................................................................................................................................... 3-18

3-18
4 Trail Management
Overview ...................................................................................................................................................................................... 4-1

4-1
Trail Management ..................................................................................................................................................................... 4-2

4-2
Trail Management: SET and UPDATE ............................................................................................................................. 4-3

4-3
Trail Management: CREATE and DELETE ................................................................................................................... 4-4

4-4
Trail Management: CONSTR ............................................................................................................................................... 4-5

4-5
Trail Management: ALLOC and DEALLOC ................................................................................................................. 4-6

4-6
Trail Management: IMPL and DEIMPL .......................................................................................................................... 4-7

4-7
Trail Management: CONFIG and CONFIG .................................................................................................................... 4-8

4-8
Trail Management: PROTECT ............................................................................................................................................ 4-9

4-9
....................................................................................................................................................................................................................................
iv 8DG42097JAAA Issue 1
March 2011
Contents
....................................................................................................................................................................................................................................
Trail Management: SPLIT and JOIN .............................................................................................................................. 4-10
4-10
Trail Management: Various Updates ............................................................................................................................... 4-11

4-11
5 Path Management and Trail Management Examples
Overview ...................................................................................................................................................................................... 5-1

5-1
Network example ...................................................................................................................................................................... 5-2

5-2
Bidirectional Path ..................................................................................................................................................................... 5-3

5-3
Protected Paths with Drop and Continue ......................................................................................................................... 5-5

5-5
Broadcast Path ........................................................................................................................................................................... 5-9

5-9
Trails example ......................................................................................................................................................................... 5-21

5-21
Path that Uses HO Trails ...................................................................................................................................................... 5-26

5-26
6 PM Management
Overview ...................................................................................................................................................................................... 6-1

6-1
PM Management Overview .................................................................................................................................................. 6-2

6-2
PM Management: SET ............................................................................................................................................................ 6-3

6-3
PM Management: pMeasure Object .................................................................................................................................. 6-4

6-4
PM Management: tCRProfile Object ................................................................................................................................ 6-6

6-6
PM Management: pmCountRep Object ........................................................................................................................... 6-8

6-8
PM Management: tCAProfile Object .............................................................................................................................. 6-10

6-10
PM Management: STARTmeas, STOPmeas, CONSmeas ...................................................................................... 6-11

6-11
PM Management: CORRtransToMeas and UNCORRtransToMeas ................................................................... 6-13

6-13
PM Management: CORRTpToMeas and UNCORRTpToMeas ............................................................................ 6-14

6-14
PM Management: CORRrepToMeas and UNCORRrepToMeas .......................................................................... 6-15

6-15
PM Management: CORRpmTpToTca and UNCORRpmTpToTca ...................................................................... 6-16

6-16
PM Management: DELETEpmTp and DELETEpmTransp ................................................................................... 6-17

6-17
Start/Stop PM on transport ................................................................................................................................................. 6-18

6-18
7 ASAP Management
Overview ...................................................................................................................................................................................... 7-1

7-1
ASAP Management Overview ............................................................................................................................................. 7-2

7-2
....................................................................................................................................................................................................................................
8DG42097JAAA Issue 1 v
March 2011
Contents
....................................................................................................................................................................................................................................
ASAP Management: CREATE CLASS aSAProfile and DELETE CLASS aSAProfile ................................ 7-3
7-3
ASAP Management: CORRtoaSAProfile ........................................................................................................................ 7-5

7-5
8 Restoration Rule Management
Overview ...................................................................................................................................................................................... 8-1

8-1
Restoration Rule Management Overview ........................................................................................................................ 8-2

8-2
Restoration Rule: SET restDomId ...................................................................................................................................... 8-3

8-3
Restoration Rule: CREATE, UPDATE, DELETE ........................................................................................................ 8-4

8-4
Restoration Rule: ACT_UPDATE CLASS ObjRestRule ........................................................................................... 8-6

8-6
9 Connection Management
Overview ...................................................................................................................................................................................... 9-1

9-1
Connection Management ....................................................................................................................................................... 9-2

9-2
Connection Management: IMPL and DEIMPL ............................................................................................................. 9-3

9-3
Connection Management: MNGRawConn ..................................................................................................................... 9-5

9-5
Connection Management: CREATE and DELETE ...................................................................................................... 9-6

9-6
10 Topology Management
Overview ................................................................................................................................................................................... 10-1

10-1
Topology Management Overview .................................................................................................................................... 10-2

10-2
Topology Management: CREATE and REMOVE ..................................................................................................... 10-3

10-3
Topology Management: IMPL, DEIMPL, and UPDATE ....................................................................................... 10-9

10-9
Topology Management: SPLIT, JOIN, and OBJECT ............................................................................................ 10-12

10-12
11 NAP Management
Overview ................................................................................................................................................................................... 11-1

11-1
NAP Management Overview ............................................................................................................................................. 11-2

11-2
NAP Management: UPLOADnap .................................................................................................................................... 11-3

11-3
NAP Management: REMOVEnap ................................................................................................................................... 11-4

11-4
12 rmBatchUtil Tool
Overview ................................................................................................................................................................................... 12-1

12-1
rmBatchUtil Tool Overview ............................................................................................................................................... 12-2

12-2
....................................................................................................................................................................................................................................
vi 8DG42097JAAA Issue 1
March 2011
Contents
....................................................................................................................................................................................................................................
13 CLI Commands
Overview ................................................................................................................................................................................... 13-1

13-1
Command Table ...................................................................................................................................................................... 13-2

13-2
Reroute Path or Trail (REROUTE path/trail) ............................................................................................................... 13-4

13-4
Undo Route Path or Trail (UNDOROUTE path/trail) .............................................................................................. 13-6

13-6
UPDSNC Path, Trail, or SNC (UPDSNC path/trail/snc) ......................................................................................... 13-7

13-7
Configure Link NPA (CONFIGURELINKnpa) .......................................................................................................... 13-9

13-9
Move Objects (MOVEObjects) ...................................................................................................................................... 13-11

13-11
Move Port (MOVEport) .................................................................................................................................................... 13-13

13-13
Create Path (CREATEpath) .............................................................................................................................................. 13-15

13-15
Multiset Node (MULTSETnode) ................................................................................................................................... 13-17

13-17
Manage Switch (manageSwitch) .................................................................................................................................... 13-19

13-19
Add Ends Path (ADDENDSpath) .................................................................................................................................. 13-21

13-21
Remove Ends Path (REMOVEENDSpath) ................................................................................................................ 13-23

13-23
Connect Trail (CONNECTtrail) ..................................................................................................................................... 13-25

13-25
Disconnect Trail (DISCONNECTtrail) ....................................................................................................................... 13-27

13-27
Update Class (UPDATE CLASS) .................................................................................................................................. 13-29

13-29
Update ET / Update Node (Update et/Update node) .............................................................................................. 13-30

13-30
Remove NPA (REMOVEnpa) ......................................................................................................................................... 13-31

13-31
Add NPA (ADDnpa) ........................................................................................................................................................... 13-32

13-32
Add Leg to Path (ADDLEGtoPath) .............................................................................................................................. 13-34

13-34
Remove Leg from Path (REMOVELEGfromPath) ................................................................................................ 13-36

13-36
Remove Leg Keep NAP in Path (REMOVELEGkeepNapInPath) ................................................................... 13-38

13-38
A List of Abbreviations
Abbreviations ............................................................................................................................................................................ A-1

A-1
Index
....................................................................................................................................................................................................................................
8DG42097JAAA Issue 1 vii
March 2011
Contents
....................................................................................................................................................................................................................................
....................................................................................................................................................................................................................................
viii 8DG42097JAAA Issue 1
March 2011
About this document
About this document
Purpose
This preface provides an overview of this information product (IP), which is the 1350
OMS CLI Reference.
The purpose of the 1350 OMS CLI Reference is to provide reference material for the
Command Line Interface commands to the systems engineers, programmers, and
advanced users of the 1350 OMS 9.1.1.
Reason for revision

This issue of the 1350 OMS CLI Reference supports the Alcatel-Lucent 1350 OMS 9.1.1.
Safety information
This document does not contain any safety information (cautions or warnings) because
the 1350 OMS is a software product.
Important! When working with any hardware that is associated with any piece of
software, always refer to the safety information that the hardware manufacturer provides
for that particular piece of hardware. For example, when working with an HP® server,
refer to safety information that is provided in the HP® documentation for that server.
When working with any Alcatel-Lucent network element, refer to safety information that
is provided in the Alcatel-Lucent documentation for that particular NE.
Intended audience
The 1350 OMS CLI Reference is written primarily for the advanced users of the 1350
OMS, who typically are systems engineers, programmers, and system administrators.
How to use this information product

In the broadest sense, this document contains conceptual information.
The conceptual information complements and enhances the step-by-step instructions that
are found in many of the tasks in the document set. Use the conceptual information to
broaden your general knowledge of the network management system. It is best if you read
all conceptual information and have a good understanding of the concepts being presented
before undertaking the step-by-step instructions that are given in any task in the document
set.
...................................................................................................................................................................................................................................
8DG42097JAAA Issue 1 ix
March 2011
About this document
....................................................................................................................................................................................................................................
A term that is presented in the text of this document, along with any used abbreviation for
the term, is typically defined where the term is initially introduced. Many of the more
generic terms that are defined in this document, along with the terms that are defined in
other documents in this documentation set, are also defined in the Glossary, which is part
of the 1350 OMS Getting Started Guide. We encourage our readers to rely on the
Glossary for a comprehensive set of terms and any abbreviations of the terms.
This document can be used in its on-line versions (HTML/PDF) or in paper version (print
PDF). The on-line HTML document version has a search capability, a full table of
contents in the front matter of the document, a partial table of contents in each chapter, an
index for each document, and an index for the entire documentation set. Use all of these
tools to help find information quickly. However, be aware that the index for each
document and the index for the entire documentation set are the preferred search tools.
Important! This document contains information on the complete line of network
elements (NEs) that the product supports. Each release of the 1350 OMS and its
applications supports certain NEs within the Alcatel-Lucent family of optical NEs.
Mention of NEs or specific NE features in the text of this document, or any document
in the 1350 OMS documentation set, that are not supported in this particular product
release can apply to prior or future product releases. Such material may not be
currently visible or operable on the GUI and/or the server and has been added only as
a convenience for our customers. This material is subject to change. For a list of NEs
that are supported in the 1350 OMS 9.1.1, contact your Alcatel-Lucent local customer
service support team.
In addition, this document, or any document in the 1350 OMS documentation set,
may contain information that is related to features, service packs (SPs), maintenance
releases, or other updates that our product and its applications supported in prior
releases or is to support in the near future. This material may not be visible or
operable on the supported servers and/or GUI, and has been added only as a
convenience for our customers. This material is subject to change. For a list of all
supported features for a particular release, contact your Alcatel-Lucent local customer
service support team.
In general, the technical material in this document is augmented by technical material
that is provided in other documents in this documentation set. It is the reader's
responsibility to read all pertinent material in the documentation set in order to
understand a particular concept or procedure and/or to implement the procedure in his
or her working environment.
Example: The Administration Guide for the 1350 OMS is a set of documents that is
published in volumes to reduce the size of the overall document. Each volume
contains technical material that can augment material in other documents in the
document set. The system administrator must be knowledgeable of the material that is
in each volume of the set. In addition, other documents in the documentation set, such
as the 1350 OMS Getting Started Guide and the 1350 OMS Service Assurance Guide,
contain other important information to the administration of the system. The
administrator must also be knowledgeable of the material that is in each of these
documents.
....................................................................................................................................................................................................................................
x 8DG42097JAAA Issue 1
March 2011
About this document
....................................................................................................................................................................................................................................
Conventions used
The conceptual information typically introduces each chapter or section of each chapter.
The information presented in this area varies according to the topic being
explained—sections, subsections, tables, figures, and screen captures can be commonly
found.
This document, and the documents in this document set, rely on the following
typographical conventions to distinguish between user input and computer output.
• When describing the 1350 OMS software, fields in windows and field entries are
identified with this font.
• When describing the UNIX® environment, text and numbers that the user inputs to
the computer are identified with boldface type.
• When describing system output in the UNIX® environment, text and numbers are
identified with monospace type.
• When displaying system output in the UNIX® environment, output displays are
identified with the following boundary:
This is an example of system output in the UNIX® environment.

Occasionally, a set of 1350 OMS features is not supported for all NEs or for all operating
component and/or environments. This set of features is clearly marked to show these
exceptions.
Related documentation
The document set that supports the Alcatel-Lucent 1350 OMS 9.1.1 release set can be
ordered on CD-ROM. The part number for this CD-ROM is 8DG42100AAAA. This
CD-ROM contains the following 1350 OMS 9.1.1 release set documents:
1. The 1350 OMS Getting Started Guide (8DG41965AAAA) explains the look-and-feel
of the user and administration GUIs to new users. This document contains a complete
explanation of the 1350 OMS information product set and a glossary of terms that is
applicable to the entire documentation set.
2. The 1350 OMS Administration Guide (8DG41965KAAA) explains how to use the
tools and the administration GUIs to administer and maintain the element
management layer, network management layer, and service management layer of the
1350 OMS.
This document consists of the following volumes:
• The 1350 OMS Administration Guide, Vol 1: Common Tools and Processes
(8DG41965KAAA-Vol1) is volume 1 of the set. This document explains how to
administer and maintain the common tools and processes that are associated with
the 1350 OMS.
• The 1350 OMS Administration Guide, Vol 2: Common GUI Functions
administer and maintain the common administration GUIs that are associated with
the 1350 OMS.
....................................................................................................................................................................................................................................
8DG42097JAAA Issue 1 xi
March 2011
About this document
....................................................................................................................................................................................................................................
• The 1350 OMS Administration Guide, Vol 3: 1350 OMS EML (8DG41965KAAA-
Vol3) is volume 3 of the set. This document explains how to administer and
maintain the 1350 OMS EML, which is the element management layer of the
1350 OMS.
• The 1350 OMS Administration Guide, Vol 4: 1350 OMS eOMS
administer and maintain the 1350 OMS eOMS, which is the embedded Optical
Management System application of the 1350 OMS.
• The 1350 OMS Administration Guide, Vol 5: 1350 OMS PKT (8DG41965KAAA-
maintain the Packet application of the 1350 OMS that provides Ethernet network
management layer support.
•
The 1350 OMS Administration Guide, Vol 6: 1350 OMS SDH (8DG41965KAAA-
maintain the Synchronous Digital Hierarchy (SDH) network management layer
for the 1350 OMS.
• The 1350 OMS Administration Guide, Vol 7: 1350 OMS SONET
administer and maintain the Synchronous Optical Network (SONET) network
management layer for the 1350 OMS.
• The 1350 OMS Administration Guide, Vol 8: 1350 OMS WDM
administer and maintain the Wavelength Division Multiplexing (WDM) and
Dense Wavelength Division Multiplexing (DWDM) network management layer
for the 1350 OMS.
3. The 1350 OMS EML User Guide (8DG41965BAAA) explains how to use 1350 OMS
EML application of the 1350 OMS, which is the element management layer of the
1350 OMS.
4. The 1350 OMS PKT User Guide (8DG41965DAAA) explains how to use Packet
(PKT) application of the 1350 OMS that provides Ethernet network management
layer support.
5. The 1350 OMS Service Assurance Guide (8DG41965FAAA) explains how to
maintain the 1350 OMS in terms of activities such as alarm clearing and performance
monitoring.
6. 1350 OMS CLI Reference (8DG41965JAAA) provides detailed reference material on
the Command Line Interface for the advanced user of the 1350 OMS.
The 1350 OMS 9.1.1 also supports modules for system resiliency and northbound
communication. These modules are explained in the following documents:
• 1350 OMS HA Guide (8DG41965GAAA) explains how to install, administer, and use
the High Availability feature.
• 1350 OMS OI Guide (8DG41965HAAA) explains how to install, administer, and use
the Open Interfaces that are supported for the 1350 OMS.
In addition, the 1350 OMS 9.1.1 also supports installation and migration activities with
related documentation. Contact your Alcatel-Lucent local customer service support team
for additional details.
....................................................................................................................................................................................................................................
xii 8DG42097JAAA Issue 1
March 2011
About this document
....................................................................................................................................................................................................................................
Help products
The 1350 OMS includes an extensive set of help systems that are designed to consider the
task the user is performing and help that user successfully perform the task. The help
products can be accessed from the Help menu that is displayed on the GUI window.
How to order
The ordering number for this document is 8DG42097JAAA. To order any 1350 OMS
document, contact your local Alcatel-Lucent local customer service support team.
In addition, to order the 1350 OMS and/or any of its applications, add-on features or
upgrades, contact your local Alcatel-Lucent local customer service support team.
How to comment
To comment on this document, go to the Online Comment Form (http://infodoc.alcatel-
lucent.com/comments/enus/) or e-mail your comments to the Comments Hotline
(comments@alcatel-lucent.com).
....................................................................................................................................................................................................................................
8DG42097JAAA Issue 1 xiii
March 2011
About this document
....................................................................................................................................................................................................................................
....................................................................................................................................................................................................................................
xiv 8DG42097JAAA Issue 1
March 2011
1 Overview
1
Overview
Purpose
This chapter provides an overview of the 1350 OMS and of the Command Line Interface
(CLI) commands that are available.
Contents
1350 OMS Overview 1-2

1350 OMS Modules for System Resiliency and Northbound Communication 1-6
Command Description 1-7
...................................................................................................................................................................................................................................
8DG42097JAAA Issue 1 1-1
March 2011
Overview 1350 OMS Overview
....................................................................................................................................................................................................................................
1350 OMS Overview

1350 OMS and its supported management layers
The 1350 OMS is a network management system that supports several management
layers that can accommodate and grow with a customer's optical network.
The Element Management Layer, or EML, provides the functionality that is needed to
access any Alcatel-Lucent supported network elements (NEs) that are deployed in a
customer network. The EML provides a single access point for communication with an
NE.
The Network Management Layer, or NML, provides the functionality that is needed to
commission, provision, and supervise the network that is deployed in a customer premise.
The Service Management Layer, or SML, provides the functionality that is needed to
commission, provision, and supervise a Virtual Private Network (VPN) that an
Alcatel-Lucent customer deploys to its end users or to its customers.
1350 OMS and its applications

The 1350 OMS is the Alcatel-Lucent converged and unified network management
system. It manages the complete portfolio of Alcatel-Lucent's active network elements
(NEs) and it maintains the complete portfolio of Alcatel-Lucent's legacy NEs.
The 1350 OMS consists of the following set of integrated, licensed applications:
• “1350 OMS EML” (p. 1-2)
• “1350 OMS PKT” (p. 1-3)
• “1350 OMS SDH” (p. 1-3)
• “1350 OMS SONET” (p. 1-3)
• “1350 OMS WDM” (p. 1-4)
Refer to the 1350 OMS Getting Started Guide for a more detailed system description.
1350 OMS EML

The 1350 OMS EML application provides element level management (EML) capabilities
for both Alcatel-Lucent ANSI and ETSI NEs. Its set of protocol adapters supports basic
NE functions such as NE MIB backup/restore and software downloads. Because the 1350
OMS provides all of the element layer functions that are required to manage the deployed
network, it requires the 1350 OMS EML application and/or the 1350 OMS eOMS legacy
management system to also be deployed. (See “Legacy management and NE support”
(p. 1-4).)
Refer to the following documents and contact your Alcatel-Lucent local customer service
support team for additional details:
• 1350 OMS Administration Guide, Vol 3: 1350 OMS EML
• 1350 OMS EML User Guide
• 1350 OMS Service Assurance Guide
....................................................................................................................................................................................................................................
1-2 8DG42097JAAA Issue 1
March 2011
....................................................................................................................................................................................................................................
1350 OMS PKT
The 1350 OMS PKT application provides Ethernet network management layer support
along with provisioning, alarm correlation, and historical PM data services. Ethernet
services include Multi-Protocol Label Switching (MPLS), Transport-Multi-Protocol Label
Switching (T-MPLS), bridging, connection-oriented traffic, and packet rings.
• 1350 OMS Administration Guide, Vol 5: 1350 OMS PKT
• 1350 OMS PKT User Guide
1350 OMS SDH

The 1350 OMS SDH application provides the Synchronous Digital Hierarchy (SDH)
network management layer along with provisioning, alarm correlation, and PM
correlation capabilities. The 1350 OMS SDH functions as a client for the 1350 OMS
WDM application and as a server for the 1350 OMS PKT application.
• 1350 OMS Administration Guide, Vol 6: 1350 OMS SDH
• 1350 OMS SDH User Guide, Vol 1: Basic Management
• 1350 OMS SDH User Guide, Vol 2: Enhanced Solutions
• 1350 OMS CLI Reference
For 1350 OMS support of SDH in a legacy system, refer to “Legacy management and NE
support” (p. 1-4) for details.
1350 OMS SONET

The 1350 OMS SONET application provides direct Synchronous Optical Network
support along with provisioning, alarm correlation, and historical PM data capabilities.
The 1350 OMS SONET functions as a client for the 1350 OMS WDM application and as
a server for the 1350 OMS PKT application.
• 1350 OMS Administration Guide, Vol 7: 1350 OMS SONET
• 1350 OMS SONET User Guide
For 1350 OMS support of SONET in a legacy system, refer to “Legacy management and
NE support” (p. 1-4) for details.
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
1350 OMS WDM
The 1350 OMS WDM application provides Wavelength Division Multiplexing (WDM)
and Dense Wavelength Division Multiplexing (DWDM) support along with provisioning,
alarm correlation, and historical PM correlation capabilities.
• 1350 OMS Administration Guide, Vol 8: 1350 OMS WDM
• 1350 OMS WDM User Guide
For 1350 OMS support of WDM and DWDM in a legacy system, refer to “Legacy
management and NE support” (p. 1-4) for details.
1350 OMS software and the Web

1350 OMS is run through an Internet browser-based Graphical User Interface (GUI). It
supports the standard web features that a browser offers, such as bookmarks, back,
forward, reload, and print.
The Web Desktop is the available mechanism that both system administrators and users
can use to access the 1350 OMS GUI. It provides a central access point from which both
system administrators and users are authenticated and from which they can navigate to
the Web Portal to access the 1350 OMS applications.
The Web Portal is a Java application that is started when the administrator or user logs in
from the Web Desktop. The Web Portal provides the administrator with a view of all 1350
OMS applications and manages GUI navigation between the subsystem components. The
Web Portal also provides various methods of navigation—such as menus, icons, and a left
tree navigation area—between applications and tools.
From the 1350 OMS Web Portal, administrators can set up each application and its users,
and users can access the network and element level applications that enable the family of
Alcatel-Lucent NEs to be provisioned.
Refer to the 1350 OMS Getting Started Guide for a more detailed description of the look
and feel of the software and for a glossary of terms and acronym list.
Legacy management and NE support

Through its Web Portal, the 1350 OMS provides users with the ease of accessing and
using the familiar embedded Optical Management System (eOMS) to provision the NEs
that are managed through the 1350 OMS eOMS and the NEs that are managed through an
XML-over-socket (XoS) interface (such as TNA, CNA, or ITM-SC).
Refer to the following documents for additional information on the 1350 OMS eOMS:
• 1350 OMS Getting Started Guide
• 1350 OMS Administration Guide, Vol 4: 1350 OMS eOMS
• 1350 OMS eOMS Connection Management User Guide
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
• 1350 OMS eOMS Ethernet Management User Guide
• 1350 OMS eOMS Service Assurance User Guide
• 1350 OMS eOMS Network Element Management User Guide
Because the 1350 OMS provides all of the element layer functions that are required to
manage the deployed network, it requires the 1350 OMS EML application and/or the
1350 OMS eOMS legacy management system to also be deployed. (See “1350 OMS
EML” (p. 1-2).)
1350 OMS supported NEs

The 1350 OMS supports the Alcatel-Lucent family of optical network elements (NEs). To
accommodate the world of optical transmission standards, these NEs operate using
different transport structures and they support different native command languages.
Contact your local customer support team for a list of NEs that are supported by the 1350
OMS and its particular applications.
Important! Each release of the 1350 OMS and its applications supports certain NEs
within the Alcatel-Lucent family of optical NEs. Mention of NEs or specific NE features
in the text of this document, or any document in the 1350 OMS documentation set, that
are not supported in this particular product release can apply to prior or future product
releases. Such material may not be currently visible or operable on the GUI and/or the
server and has been added only as a convenience for our customers. This material is
subject to change. For a list of NEs that are supported in the 1350 OMS 9.1.1, contact
your Alcatel-Lucent local customer service support team.
....................................................................................................................................................................................................................................
March 2011
Overview 1350 OMS Modules for System Resiliency and Northbound
Communication
....................................................................................................................................................................................................................................
1350 OMS Modules for System Resiliency and Northbound

Communication
1350 OMS HA
The 1350 OMS supports High Availability (HA) as an added value module, which is
referred to as the 1350 OMS HA. The 1350 OMS HA software package is installed on top
of an already installed and configured NML and EML platform and independently of any
other application such as the 1350 OMS SDH, 1350 OMS PKT, 1350 OMS WDM, or
1350 OMS SONET, or any element manager such as the 1350 OMS EML or 1350 OMS
eOMS.
As its name suggests, the 1350 OMS HA provides high availability to these applications
whose main task is to manage transport networks. It protects the 1350 OMS applications
and its HP® server platform against hardware and software failures that could be caused
by system failures (such as the failure of the system power supply or a system
component), a site failure (such as a natural disaster or fire), a backplane failure, a
processor failure, or any unplanned outage.
The 1350 OMS HA is explained in detail in the 1350 OMS HA Guide
(8DG41965GAAA). This document includes installation, administration, and user
information for the 1350 OMS High Availability (HA) feature.
Contact your Alcatel-Lucent local customer service support team for additional details.
1350 OMS OI
The 1350 OMS OI software package is installed on top of an already installed and
configured MW-INT platform and independently of any other application such as the
1350 OMS SDH, 1350 OMS PKT, 1350 OMS WDM, or 1350 OMS SONET, or any
element manager such as the 1350 OMS EML or 1350 OMS eOMS.
The 1350 OMS OI enables the 1350 OMS applications to export or import data to
multiple external operation systems (OSs). The 1350 OMS OI is a flexible, powerful, and
effective set of generic OS-to-OS interfaces (GENOS) that allow an external OS to
synchronize alarms, performance monitoring, network inventory, and remote inventory
data with any of the 1350 OMS applications.
The 1350 OMS OI is explained in detail in the 1350 OMS OI Guide (8DG41965HAAA).
This document includes installation, administration, and user information for the Open
Interfaces (OIs) that are supported for the 1350 OMS.
Contact your Alcatel-Lucent local customer service support team for additional details.
....................................................................................................................................................................................................................................
March 2011
Overview Command Description
....................................................................................................................................................................................................................................
Command Description
Command description overview
The commands that are available offer the following capabilities:
• Set the network where commands are to be executed (called working network).
• Define, delete, update, deallocate, (de)implement, and protect/unprotect paths (with or
without constraints).
• Change NAD to paths, network access points (NAPs), trails, and link connections
• Treat PM features, such as creating and removing measures or relating a termination
point (tp) to some measures.
• Create, update, and delete the class aSAProfile.
• Create, update, and delete the class restRule.
• Manage connections in a topology.
• Create, remove, and deimplement a topology and a physical connection.
• Upload and remove a network access point (NAP).
• Configure an elementary topology (et) and a physical connection.
Comment lines can also be introduced in the command file to document a particular
command. See “Comments” (p. 1-8) for more details.
A command file can contain all types of commands. However, it is important to set the
work network, via a input parameters, before executing the commands on paths and trails.
BNF description
To describe the syntactic structure of the commands, the Backus–Naur form (BNF),
which is a metasyntax that is used to express context-free grammars, is used. Refer to the
following table for details.
BNF
Item Symbol Meaning
pipe symbol {|} Use one item in the braces that are separated
within braces by pipes.
brackets [] The item in the brackets is optional. If the
brackets enclose multiple items separated by
pipes (|), any one item or none at of the items
can be used.
ellipsis ... The previous item can be repeated multiple
times.
underline _ All bracketed items can be omitted. The
underlined item is the default.
....................................................................................................................................................................................................................................
March 2011
Overview Command Description
....................................................................................................................................................................................................................................
BNF
Item Symbol Meaning
<string> <'string'> A number or character sequence that is
<” 'string1a' string1.”> between a single quote or a double quote. If
double quotes are used, single quotes can be
used inside the string.
Examples:
'test userLabel' / "test userLabel" / "test user
'Label"
tab key/character |<- Not an allowed character.
->|
pipe | Not an allowed character.
backslash \ Not an allowed character.
tilde ~ Not an allowed character.
backquote ` Not an allowed character.
double quotes ” Not an allowed character.
“
sequence of <number>: A sequence of digits
numbers Example:
32 :=
An expression is defined.
<date> YYYY/MM/DD-hh:mm:ss For the date format:
YYYY: the four digit of year that is > 1970
MM: month (01-12)
DD: day of month (01-31)
hh: hour of day (00-23)
mm: minute (00-59)
ss: second (00-59))
Comments
A comment can be specified in a line of the command file if the line begins with an
exclamation point. Comments are delimited by a character that signifies a new line
(return, carriage return).
!
Example:
! This is an example of a first line that is a comment.

! This is an example of a second line that is a comment.
....................................................................................................................................................................................................................................
March 2011
2 Common Command Verbs
2
Overview
Purpose
This chapter provides the 1350 OMS advanced user with the conceptual information that
pertains to some of the more common command verbs that are offered with the Command
Line Interface.
Contents
PRINT, SLEEP, and EXIT Commands 2-2

CHOWNonObj and ACT_UPDATE Commands 2-3
SET Commands 2-4
MOVE and MULTISET Commands 2-5
CONFIGURE Command 2-7
SYNCHRONIZE CLASS eml/ne 2-9
CONSISTENCY Command 2-10
NT MNGPdhAlr 2-11
...................................................................................................................................................................................................................................
March 2011
Common Command Verbs PRINT, SLEEP, and EXIT Commands
....................................................................................................................................................................................................................................
PRINT, SLEEP, and EXIT Commands

PRINT
The PRINT command prints a string.
PRINT syntax
PRINT <string>
SLEEP
The SLEEP command enables a program to wait for a specified number of seconds
between two commands.
SLEEP syntax
SLEEP <number>
EXIT
The EXIT command stops the utility and displays final statistics. This command is useful
when the utility is running with -f- option.
EXIT syntax
EXIT
....................................................................................................................................................................................................................................
March 2011
Common Command Verbs CHOWNonObj and ACT_UPDATE Commands
....................................................................................................................................................................................................................................
CHOWNonObj and ACT_UPDATE Commands

CHOWNonObj
The CHOWNonObj command is used to update the security label of a path, trail,
network access point (NAP), or link connection.
CHOWNonObj parameter value options
objClass := nap | path | trail

CHOWNonObj <objClass>
userLabel <user_label>
securityLabel <number>
END
CHOWNonObj syntax
CHOWNonObj lc
position_attribute <number>
securityLabel <number>
END
ACT_UPDATE CLASS
The ACT_UPDATE command is used to change the service state for one object of
CLASS, which can be a path, a trail, or a physical connection, to in service or
out-of-service.
ACT_UPDATE CLASS syntax
ACT_UPDATE CLASS { path | trail | physicalConn }

updList
serviceState { inService | notInService }
END
END
....................................................................................................................................................................................................................................
March 2011
Common Command Verbs SET Commands
....................................................................................................................................................................................................................................
SET Commands
Available commands for the SET verb
The following SET commands are available:
• “SET timeout” (p. 2-4)
• “SET local and SET gmt0” (p. 2-4)
• “SET ntwId” (p. 2-4)
• “SET ntwLabel” (p. 2-4)
SET timeout
The SET timeout command sets the time out, which is expressed as the number of
seconds, of CI messages (get and actions).
SET timeout syntax
SET timeout <number> END
SET local and SET gmt0

The SET command can be used to choose a time reference for dates. If the local time
reference is chosen, all dates are converted to GMT0 time, which is the typical behavior
of a US application. (GMT0 and UTC are functionally equivalent.) If the GMT0 time
reference is set, a conversion is not applied to the dates, which is the correct behavior for
executing a redolog operation. The default behavior is to apply the date conversion to
GMT0 time.
SET local and SET gmt0 syntax
SET local END

SET gmt0 END
SET ntwId
The SET command can be used to define the number of the network (the network ID or
ntwId) where the commands are to take effect:
SET ntwId syntax
SET ntwId <number> END
SET ntwLabel
The SET command can be used to define the network where the commands are to take
effect:
SET ntwLabel syntax
SET ntwLabel <userlabel> END
....................................................................................................................................................................................................................................
March 2011
Common Command Verbs MOVE and MULTISET Commands
....................................................................................................................................................................................................................................
MOVE and MULTISET Commands

MOVE Objects (node | port)
MOVE Objects {node | port}

newParentLabel {sbn1stLev | sbn2stLev | node} "newParentUserLabel"
movingObjList
userLabel "moveObjectUserLabel_1"
userLabel "moveObjectUserLabel_2"
...
userLabel "moveObjectUserLabel_n"
END
END
MOVE Port
MOVE port
sourceNode "userLabel source node"
destNode "userLabel destination node"
userLabel "user label port_1"
destUserLabel "new user label port_1" {toBeCreated}
.......... ..........
userLabel "user label port_n"
destUserLabel "new user label port_n" {toBeCreated}
END
MULTISET node
MULTSET node userLabel "node-label"

<routingDomain-automatic> |
<routingDomain-listOfPort>|
<routingDomain-state>
END
Where:
<routingDomain-automatic> = ROUTING_DOMAIN_AUTOMATIC
<routingDomain-listOfPort> = routingDomainName "label" | <null-domain> |
ALL_PORT | <port-list>
<port-list> = portList <portElem> [<portElem>] END
<portElem> = userLabel "label"
<null-domain> = NULL
<routingDomain-state> = routingDomainState
....................................................................................................................................................................................................................................
March 2011
Common Command Verbs MOVE and MULTISET Commands
....................................................................................................................................................................................................................................
<rouDom-state> <rouDom-state> = disabled | enabledForPartitioning |
enabledForMigration
....................................................................................................................................................................................................................................
March 2011
Common Command Verbs CONFIGURE Command
....................................................................................................................................................................................................................................
CONFIGURE Command
Available commands for the CONFIGURE verb
The following CONFIGURE commands are available:
• “CONFIGURE et” (p. 2-7)
• “CONFIGURE physicalConnection” (p. 2-7)
• “CONFIGURE ne” (p. 2-8)
• “CONFIGURE emldomain” (p. 2-8)
CONFIGURE et
The CONFIGURE command is used to configure the payload (payloadStructureList) in an
elementary topology (et).
CONFIGURE et syntax
CONFIGURE et
payloadStructureList
vc3Num <integer>
vc4Num <integer>
vc12Num <integer>
END
END
CONFIGURE et example
CONFIGURE et
userLabel 'et1'
vc3Num 0
vc4Num 4
vc12Num 0
END
END
CONFIGURE physicalConnection
The CONFIGURE command is used to configure the payload (payloadStructureList) in a
physical connection (physicalConnection).
CONFIGURE physicalConnection syntax
vc3Num <integer>
vc4Num <integer>
vc12Num <integer>
....................................................................................................................................................................................................................................
March 2011
Common Command Verbs CONFIGURE Command
....................................................................................................................................................................................................................................
END
END
Configure physicalConnection example
userLabel 'physicalConnection1'
vc3Num 0
vc4Num 4
vc12Num 0
END
END
CONFIGURE ne
The CONFIGURE command is used to configure a download for an NE
CONFIGURE ne syntax
CONFIGURE ne
userLabel <ne_user_label>
consistencyType { download | notifyAudit | markAudit }
END
CONFIGURE ne example
CONFIGURE ne
userLabel "1661-1sen"
download disable
END
CONFIGURE emldomain
The CONFIGURE command is used to configure a download for an EML domain
(emlDomain).
CONFIGURE emlDomain syntax
CONFIGURE {ne | emlDomain}

END
CONFIGURE emlDomain example
CONFIGURE emlDomain
userLabel "1661"
download enable
END
....................................................................................................................................................................................................................................
March 2011
Common Command Verbs SYNCHRONIZE CLASS eml/ne
....................................................................................................................................................................................................................................
SYNCHRONIZE CLASS eml/ne

The scope of this command is Synchronize EML Domain/NE (in order to allow SDH to
upload the Q3 NEs with the related SDH and PDH ports)
syntax
userLabel "…"
END
EXAMPLE:
SYNCHRONIZE CLASS eml
userLabel "neGroup100"
END
....................................................................................................................................................................................................................................
March 2011
Common Command Verbs CONSISTENCY Command
....................................................................................................................................................................................................................................
CONSISTENCY Command
CONSISTENCY
The CONSISTENCY command is used to perform a consistency check on the NE.
CONSISTENCY syntax
CONSISTENCY
END
CONSISTENCY example
CONSISTENCY
userLabel "1674sx-2">
consistencyType markAudit
END
....................................................................................................................................................................................................................................
March 2011
Common Command Verbs NT MNGPdhAlr
....................................................................................................................................................................................................................................
NT MNGPdhAlr
NT management
Syntax
MNGPdhAlr
userLabel "userLabel del path"
AlrType {unframed | framed | isdnPra | leasedLinePra}
endTpList
[ portName "userLabel della porta" ]
[ portName "userl Label della porta" ]
END
END
Where:
AlrType = unframed | framed the ports are not of any consequence
AlrType = isdnPra | LeasedLinePra a port that is meaningful.
NT MNGPdhAlr example
NT MNGPdhAlr
userLabel "path2mbret"
AlrType leasedLinePra
endTpList
portName "1660_Dublin/r01s1b31p02"
portName "1660_Dublin/r01s1b31p01c01"
END
END
....................................................................................................................................................................................................................................
March 2011
Common Command Verbs NT MNGPdhAlr
....................................................................................................................................................................................................................................
....................................................................................................................................................................................................................................
March 2011
3 Path Management
3
Overview
Purpose
pertains to the CLI commands for path management.
Contents
Path Management 3-2

Path Management: SET and UPDATE 3-3
Path Management: CREATE and DELETE 3-5
Path Management: CONSTR, REROUTE, and UNDOREROUTE 3-6
Path Management: ALLOC and DEALLOC 3-8
Path Management: IMPL and DEIMPL 3-9
Path Management: PROTECT 3-10
Path Management: ADDLEG and REMOVELEG 3-12
Path Management: COMMISSION and UNCOMMISSION 3-13
Path Management: SPLIT and JOIN 3-14
Path Management: CONNECT and DISCONNECT 3-15
Path Management: Various Updates 3-16
SAVEROUTE/RECALLROUTEpath/trail 3-17
Path Examples 3-18
...................................................................................................................................................................................................................................
March 2011
Path Management Path Management
....................................................................................................................................................................................................................................
Path Management
Available commands for the path object
The following path management commands are available:
• “SET path” (p. 3-3)
• “CREATE path” (p. 3-5)
• “CONSTR path” (p. 3-6)
• “ALLOC path” (p. 3-8)
• “DEALLOC path” (p. 3-8)
• “DEIMPL path” (p. 3-9)
• “IMPL path” (p. 3-9)
• “DELETE path” (p. 3-5)
• “UPDATE path” (p. 3-3)
• “PROTECT path” (p. 3-10)
• “ADDLEG path” (p. 3-12)
• “REMOVELEG path” (p. 3-12)
• “COMMISSION path” (p. 3-13)
• “UNCOMMISSION path” (p. 3-13)
• “UPDALR path” (p. 3-16)
• “CONNECT path” (p. 3-15)
• “DISCONNECT path” (p. 3-15)
• “ELEMALRMNG path” (p. 3-16)
• “SPLIT path” (p. 3-14)
• “JOIN path” (p. 3-14)
• “REROUTE path | trail” (p. 3-7)
• “UNDOREROUTE path | trail” (p. 3-7)
• “UPDSNC path | trail | snc” (p. 3-16)
Extensive examples of paths and trails

Because of the interworking between paths and trails, Chapter 5, “Path Management and
Trail Management Examples” contains extensive examples on the CLI commands that are
used to create and manipulate paths and trails.
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: SET and UPDATE
....................................................................................................................................................................................................................................
Path Management: SET and UPDATE

SET path
The SET path command enables default values to be set for attributes or default values to
be specified at the path creation (definition) time.
SET path parameter value options
upd_path_attributes :=
[ pathType unidirectionalPtoPto | pathType unidirectionalBroadcast |
pathType bidirectionalPtoPto]
[ pathRate lo2Mb | pathRate lo34Mb | pathRate ho140Mb| pathRate
lo45Mb]
[concatenationLevel 0..7]{ protType notProtected | protType
shSegmentProtected | protType sh1Plus1EToEProt | protType
enhancedProtected }
[ allocRule automatic | allocRule user ]
[ allocationConstraint notAlarmedResourcesOnly |
allocationConstraint noRestriction ]
[ implRule automatic | implRule user ]{userId <string>}
[ msProtProfile normal | msProtProfile protPref]
[ comment1 <string>] [ comment2 <string>] [ comment3 <string>]
not_upd_path_attributes:=
[alarmPropRule whenDefined | alarmPropRule whenAllocated | alarmPro
pRule whenImplemented | alarmPropRule whenCommissioned]]
[pmAutomatic false | pmAutomatic true]
[pathGroup <string>]
[ sdhAlrEnabRule onImplementation | sdhAlrEnabRule onCommissioning
|sdhAlrEnabRule manual ]
[ pdhAlrEnabRule onImplementation | pdhAlrEnabRule onCommissionin
pdhAlrEnabRule manual ]
[ transportRate { loTu12 | loTu3 | hoAu4 | hoAu3 | hoAu4conc4 |
hoAu4conc16 | hoAu4conc64 |sts1 | sts1Tu3 | sts3c | sts12c| sts48c
| sts192c | au4virtN | notDefined } ]
[ configurationRate notMeaningful | configurationRate notConfigured
| configurationRate auto10Mb | configurationRate manual10Mb |
configurationRate auto100Mb | configurationRate manual100Mb ]
[ serviceType pdh | serviceType atm | serviceType ethernet |
serviceType cbr ]
path_attributes:= [<upd_path_attributes>|<not_upd_path_attributes>]
SET path syntax
SET path <path_attributes>

END
UPDATE path
The UPDATE path command is used to update the attributes of the paths.
UPDATE path syntax
UPDATE path
userLabel “user_label”
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: SET and UPDATE
....................................................................................................................................................................................................................................
updList
[userLabel <user_label>]
[<upd_path_attributes>]
END
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: CREATE and DELETE
....................................................................................................................................................................................................................................
Path Management: CREATE and DELETE

CREATE path
The CREATEpath command is used to define a path.
CREATEpath parameter value options
user_label :=<string>
port_name := <string>
node_name := <string>
tp_path_list :=
{ nap <port_name> usedDir bidirectional |
nap <port_name> usedDir source |
nap <port_name> usedDir sink |
nap <port_name> usedDir notMeaningful |
node <node_name> usedDir bidirectional [portName <port_name>]|
node <node_name> usedDir source [portName <port_name>]|
node <node_name> usedDir sink [portName <port_name>]|
node <node_name> usedDir notMeaningful [portName <port_name>]
CREATEpath syntax
CREATE path
<path_attributes>
endTpList
<tp_path_list>
<tp_path_list>
END
END
DELETE path
The DELETEpath command is used to it delete a defined path.
DELETE path syntax
DELETE path
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: CONSTR, REROUTE, and UNDOREROUTE
....................................................................................................................................................................................................................................
Path Management: CONSTR, REROUTE, and UNDOREROUTE

CONSTR path
The CONSTRpath command is used to define the routing constraints that are imposed
on a path. If the constraint list is void, all previously defined constraints that are on the
path are deleted.
CONSTR path parameter value options
position_attribute := { payloadPos | wdmFrequency }

ctp_list :=
[ctp <port_name> position_attribute <string> constrainType useMain |
ctp <port_name> position_attribute <string> constrainType useSpare |
ctp <port_name> position_attribute <string> constrainType notUseMain
|
ctp <port_name> position_attribute <string> constrainType
notUseSpare |
useMainSpare |
ctp <port_name> position_attribute <string> constrainType notUse |
ctp <port_name> position_attribute <string> constrainType useService
|
notUseService |
ctp <port_name> position_attribute <string> constrainType useMainA |
ctp <port_name> position_attribute <string> constrainType useMainZ |
ctp <port_name> position_attribute <string> constrainType useSpareA
|
ctp <port_name> position_attribute <string> constrainType useSpareZ
|
useMainSpareA |
useMainSpareZ ]
ctp_list := [ctp_element] [ctp_list]
ctp_element := ctp <port_name> position_attribute <string>
constrainType <string> [channelNumber <number 1..8>]
Important! The values useMainA-Z, useSpareA-Z, and useMainSpareA-Z are
meaningful for unidirectional paths only. For connections at node level, A is referred to
the input CTP (sink for the Link Connection) and Z is referred to the output CTP (source
for the Link Connection).
CONSTRpath syntax
userLabel "vimercate-vimercate VC4S1"
constraintSet "_AutomaticSystemSet_"
physicalConn userLabel "STM16_b25p1"
constraintType use section "spare"
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: CONSTR, REROUTE, and UNDOREROUTE
....................................................................................................................................................................................................................................
REROUTE path | trail
The REROUTE path| trail command is used to reroute a path or a trail.
REROUTE path | trail parameter value options
operationalState := { disabled | enabled | notMeaningful }

consAct : = { aIS | timingPDH }
pdhPortElement := pdhPort <port_name> retiming <operationalState>
[consequentAction <consAct>]
pdhPortList := [pdhPortList] pdhPortElement
MNGRetiming userLabel <path_label>
pdhPortList
REROUTE path | trail syntax
REROUTE {path | trail}

userLabel <path_label>
{trafficImpactsAllowed| trafficImpactsNotAllowed}
{automaticImplementation | onlyAllocation}
endTpList
tpA <optional>
tpZ <optional>
END
END
UNDOREROUTE path | trail

The UNDOREROUTE path| trail command is used to undo the rerouting of a path or a
trail.
UNDOREROUTE {path | trail} parameter value options
ctp <portName>{payloadPos | wdmFrequency} <value>

cap "portName"{payloadPos |wdmFrequency} "value"
nap "portName"
UNDOREROUTE {path | trail} syntax
UNDOREROUTE {path | trail}

userLabel <path_label>
endTpList
tpA <optional>
tpZ <optional>
END
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: ALLOC and DEALLOC
....................................................................................................................................................................................................................................
Path Management: ALLOC and DEALLOC

ALLOC path
The ALLOC path command is used to allocates resources on a defined path.
ALLOC path syntax
ALLOC path
END
DEALLOC path
The DEALLOC path command is used to deallocate resources on a defined path.
DEALLOC path syntax
DEALLOC path
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: IMPL and DEIMPL
....................................................................................................................................................................................................................................
Path Management: IMPL and DEIMPL

IMPL path
The IMPL path command is used to implement an allocated path.
IMPL path syntax
IMPL path
END
DEIMPL path
The DEIMPLpath command is used to deimplement an allocated path.
DEIMPLpath syntax
DEIMPLpath
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: PROTECT
....................................................................................................................................................................................................................................
Path Management: PROTECT

PROTECT path
The PROTECTpath command is used to change the protection on an existing path.
PROTECT path parameter value options
changeOpRes := keepingMain | keepingSpare

changeOpType := immediate | deferred
ttp_to_prot := nap <port_name> | ctp <port_name> position_
attribute <string>
protCmd := protect | addEnhancedProt
remCmd := removeEnhancedProt | removeEnhancedProtWithCheck
unprCmd := unprotect | unprotectWitchCheck
topLev := ntw | sbn | et
topLevProt := ntw | sbn | et | node
IMPORTANT! Node topology is valid only for Drop & Continue One
Node and Drop & Continue 2 Switch connection.
connProtType := legProtected | legNotProtected
endLegType := nap <port_name> | node <node_name> [portName <port_
name>]
opNapType := keepNap | releaseNap
listJoinTp := node <user_label> |
[ node <user_label> ] nap <port_name1> nap <port_name2> |
[ node <user_label> ] cap <port_name1> position_attribute <string>
cap <port_name2> position_attribute <string> |
[ node <user_label> ] ctp <port_name1> position_attribute <string>
ctp <port_name2> position_attribute <string>
PROTECT path syntax
PROTECTpath
<protCmd> <changeOpType>
endTpList
[[<ttp_to_prot> <ttp_to_prot>]
[topologyLevel <topLevProt>]]
END
END
PROTECTpath
{ <unprCmd> <changeOpRes> <changeOpType> |
<remCmd> <changeOpType> }
endTpList
[topologyLevel <topLevProt>]]
END
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: PROTECT
....................................................................................................................................................................................................................................
The ttp_to_prot in PROTECTpath and UNPROTECT path commands have to be on
the boundary of a topology. If the topology level is not specified, the trail is protected into
the upper topology level. For enhancedProtected paths, start these paths from SNCP
protected paths (protType=sh1Plus1EToEProt) and then add the service connection with
the proper PROTECT path command. See the examples.
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: ADDLEG and REMOVELEG
....................................................................................................................................................................................................................................
Path Management: ADDLEG and REMOVELEG

ADDLEG path
The ADDLEG path command is used to add a leg (and/or simply a NAP) on an existing
path.
ADDLEG path syntax
ADDLEGpath
[[allocRule automaticallyAllocated
[<changeOpType>]
[protRequired <connProtType>]]|
[allocRule onUserRequest ]]
<endLegType>
END
REMOVELEG path
The REMOVELEG path command is used to remove a leg (and/or simply a NAP) on an
existing path.
REMOVELEG path syntax
REMOVELEG path
[<changeOpType>]
[<opNapType>]
nap <port_name>
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: COMMISSION and UNCOMMISSION
....................................................................................................................................................................................................................................
Path Management: COMMISSION and UNCOMMISSION

COMMISSION path
The COMMISSION path command is used on an implemented path to declare that no
changes are possible and the path is now commissioned.
COMMISSION path syntax
COMMISSION path
END
UNCOMMISSION path
The UNCOMMISSION path command is used on an commissioned path to declare that
changes are now possible, and the path is now uncommissioned. For example,
UNCOMMISSION path is used to reroute a path.
UNCOMMISSION path syntax
UNCOMMISSION path
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: SPLIT and JOIN
....................................................................................................................................................................................................................................
Path Management: SPLIT and JOIN

SPLIT path
The SPLIT path command is used to split an existing trail into two distinct paths.
SPLIT path syntax
SPLITpath
operationalRule <opRule>
newLabel <user_label1>
<listJoinTp>
END
JOIN path
The JOINpath command is used to join two distinct paths.
JOIN path syntax
JOINpath
userLabel <user_label1>
newLabel <new_label>
<listJoinTp>
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: CONNECT and DISCONNECT
....................................................................................................................................................................................................................................
Path Management: CONNECT and DISCONNECT

CONNECT path
The CONNECT path command is used to connect the path termination points (TPs).
CONNECT path syntax
CONNECT path
<changeOpType>
endTpList
ctp <port_name> position_attribute <string>
END
END
DISCONNECT path
The DISCONNECT path command is used to is used to disconnect the path termination
points (TPs).
DISCONNECT path syntax
DISCONNECT path
endTpList
END
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Management: Various Updates
....................................................................................................................................................................................................................................
Path Management: Various Updates

ELEMALRMNG path
The ELEMALRMNG path command is used to update the Q3 PDH/SDH alarm
enabling rule.
ELEMALRMNG path syntax
ELEMALRMNG path
pdhElemAlr enable | pdhElemAlr disable |
sdhElemAlr enable | sdhElemAlr disable
END
UPDALR path
The UPDALR path command is used to update the alarmPropagationRule of an existing
path.
UPDALR path syntax
UPDALR path
<alrPropRule> |
pdhAlrEnabRule manual | pdhAlrEnabRule onImplementation |
pdhAlrEnabRule onCommissioning |
sdhAlrEnabRule manual | sdhAlrEnabRule onImplementation |
sdhAlrEnabRule onCommissioning
END
UPDSNC path | trail | snc

The UPDSNC path | trail | snc command is used to update an SNC path, trail, or
subnetwork controller (snc).
UPDSNC path | trail | snc syntax

userLabel <userLabel>
propagateToSnc | dontPropagateToSnc
updList
attrName_1 attrVal_1
attrName_2 attrVa1_2
...
attrName_n attrVal_n
END
END
....................................................................................................................................................................................................................................
March 2011
Path Management SAVEROUTE/RECALLROUTEpath/trail
....................................................................................................................................................................................................................................
SAVEROUTE/RECALLROUTEpath/trail
SAVEROUTEpath
The scope of this command is to save the route of a path.
syntax
SAVEROUTEpath
userLabel "…"
constraintSet …..
END
SAVEROUTEtrail
The scope of this command is to save the route of a trail.
syntax
SAVEROUTEtrail
userLabel " " "
END
RECALLROUTEpath
The scope of this command is to recover the previously stored route of a path.
syntax
RECALLROUTEpath
userLabel "…"
constraintSet …..
END
RECALLROUTEtrail
The scope of this command is to recover the previously stored route of a trail.
syntax
RECALLROUTEtrail
userLabel "…"
constraintSet …..
END
....................................................................................................................................................................................................................................
March 2011
Path Management Path Examples
....................................................................................................................................................................................................................................
Path Examples
Network example
The network that is illustrated in the following figure is depicted in following three
examples. NE_V1 is a virtual NE, all of the other ADMs are real NEs.
Bidirectional path example

The following example illustrates the creation, allocation (by using constraints), and
implementation of a simple bidirectional 2Mb path between ADM_1 and VADM_2.
SETpath
allocRule user
implRule userallocationConstraint noRestriction
END
SET ntwId 1
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
CREATEpath
userLabel "ADM001-VADM_3-2M-9"
pathType bidirectionalPtoPto
pathRate lo2Mb
protType notProtected
allAlgType automatic
userId "snmlr21"
pmAutomatic false
alarmPropRule whenImplemented
endTpList
nap "ADM_1/2M/1-09"
usedDir bidirectional
nap "VADM_3/2M-06"
END
END
Comments:
!! It is not necessary to define all the constraints.

! If the constaints are not defined, the routing algorithm
! chooses a route for the user.
! However, the routing algorithm uses all of the constraints that
! are related to the path when an allocation/add-remove leg/
!add-remove protection is executed!
CONSTRpath
ctp "ADM_1/West"
payloadPos "01/1/5.2"
constrainType useMain
ctp "VADM_3/STM1-2"
END
CONSTRpath
userLabel "Test 000 KL"
ctp "1660-12/STM16_2-100"
payloadPos "02/1"
trail userLabel "ne-60-1-vim VC4S15"
physicalConn
userLabel "1660-14/1660-7/stm16"
node userLabel "1660-8"
ctp "1660_6/r01s1b28p01"
payloadPos "02/1"
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
ALLOCpath
END
Comments:
!! It is not necessary to remove all of the constraints that are

related to the path. !
!! If the user does not delete them, the constraints are used
!for the next allocation phase userLabel "ADM001-VADM_3-2M-9" !
IMPLpath
END
CONNECTpath
"immediate"
endTpList
ctp "ADM_1/2M/1-09" payloadPos "03/1.1/1"
ctp "VADM_3/2M-06" payloadPos "03/1.1/1"
END
END
DISCONNECTpath
endTpList
END
END
Protected paths with drop and continue example

In the following example, an enhanced protected 2Mb path is implemented in three steps:
1. The unprotected path is implemented between Adm7 and Adm2. The path route is
forced by using TP constraints.
The route is Adm2-Adm5-VADM_2-VADM_3-Adm8-Adm7.
2. The path is SNCP protected. The spare path route is forced by using TP constraints.
The spare route is Adm2-VADM_16-VADM_15-VADM_38-VADM_34-VADM_4-
VADM_5-VADM_33-Adm7.
SNCP connections are created on Adm2 and Adm7.
3. The path is enhanced protected in RING STM-1 and RING STM-4. The service path
routes are forced by using TP constraints.
The first service route is Adm5-VADM_17-VADM_18-VADM_15. Drop & continue
connections are created on Adm5 and VADM_15.
The second service route is Adm8-VADM_11-VADM_19-VADM_33. Drop &
continue connections are created on Adm8 and VADM_33.
Comments:
! Path enhanced protected !
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
SETpath
allocRule user
implRule user
allocationConstraint noRestriction
END
SET ntwId 1
END
Comments:
!! Step 1-a not protected path is created !
CREATEpath
userLabel 'Adm7-Adm2-2M-15'
pathRate lo2Mb
userId 'snmlr21'
endTpList
nap 'Adm2/port2M-102'
END
END
CONSTRpath
userLabel ''Adm7-Adm2-2M-15''
constraintSet "AutomaticSystemSet"
ctp ''Adm2/West' payloadPos '01/1/1.3'
! ctp 'Adm5/East' payloadPos '01/1/1.3'
ctp 'Adm5/stm-1' payloadPos '01/1/1.2'
! ctp 'VADM_2/STM1-1' payloadPos '01/1/1.2'
ctp 'VADM_2/West' payloadPos '02/2/7.3'
! ctp 'VADM_3/East' payloadPos '02/2/7.3'
ctp 'VADM_3/STM1-3' payloadPos '01/1/7.2'
! ctp 'Adm8/stm-1' payloadPos '01/1/7.2'
ctp 'Adm8/East' payloadPos '01/2/2.2'
END
ALLOCpath
END
Comments:
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
!! Step 2 - a protection SNCP is added !
CONSTRpath
constraintSet "SystemSet"
constrainType useSpare
! ctp 'VADM_16/West' payloadPos '01/1/1.3'
ctp 'VADM_16/East' payloadPos '01/1/5.3'
tp 'VADM_5/STM1-1' payloadPos '01/1/1.3'
END
Comments:
!! The allocation of the spare route is executed with

! the following command !
PROTECTpath
protect deferred
endTpList
topologyLevel ntw
END
END
Comments:
!! Step 3 - service protection is added !
CONSTRpath
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
constraintSet "SetA"
ctp 'Adm5/West' payloadPos '01/1/2.3'
constrainType useService
END
Comments:
!! The allocation of the second spare route is executed

! with the following command !
PROTECTpath
addEnhancedProt deferred
endTpList
topologyLevel et
END
END
CONSTRpath
constraintSet "SetB"
END
PROTECTpath
endTpList
topologyLevel et
END
END
CONSTRpath
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
Broadcast path example 1
In the following example, a broadcast path with two legs is created between VADM_38
and NE_V1 (virtual NE). The first leg is allocated and is also protected. On the second
leg, only the TP sink is defined. The first leg is created. Note that the sink is related by the
nodename and the portname. (To define only the nodename would be sufficient.) In this
example, the system selects the port and creates the virtual NAP. If necessary, the system
can create the virtual port.
SETpath
allocRule user
implRule user
END
SET ntwId 1
END
CREATEpath
userLabel "moni"
pathType unidirectionalPtoPto
pathRate lo2Mb
userId "lts4182/snmlr24"
pmAutomatic false
endTpList
nap "VADM_38/2M-11"
usedDir source
node "NE_V1"
usedDir sink
portName "NE_V1/2M-21"
END
END
Comments:
!! Constraints are inserted that are used during the

!allocation phase !
CONSTRpath
userLabel "moni"
constraintSet "SetC"
ctp "VADM_38/West" payloadPos "06/2/7.2"
constrainType useMainZ
ctp "X27/STM1-15" payloadPos "01/2/7.2"
constrainType useMainA
ctp "NE_V1/STM1-5" payloadPos "01/2/7.2"
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
ALLOCpath
userLabel "moni"
END
Comments:
!! Constraints are added to protect the first leg

! Note the constraintType is useSpare now.
! The route of spare is:
! VADM_38,VADM_34,VADM_37,X26,NE_V1
CONSTRpath
constraintSet "SetD"
userLabel "moni"
ctp "VADM_38/East" payloadPos "03/1/2.1"
constrainType useSpareZ
constrainType useSpareA
ctp "VADM_38/STM1-2" payloadPos "01/2/7.3"
END
Comments:
!! The allocation of the spare is executed by

! using the constraints. !
PROTECTpath
userLabel "moni"
protect deferred
endTpList
nap "VADM_38/2M-11"
nap "NE_V1/2M-21"
topologyLevel ntw
END
END
Comments:
!! Another leg is just defined. !

....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
ADDLEGpath
userLabel "moni"
allocRule onUserRequest
node "NE_V1"
END

In this example, a broadcast path with six legs is allocated. Five legs are also SNCP
protected. The following figure illustrates the ring network and the routing of the legs in
the network.
Broadcast path 'circular 1'
leg1 - from VADM_17 to VADM_17 (not protected)

route: VADM_17,VADM_18,VADM_15,VADM_16,Adm2,Adm5,VADM_17
leg2 - from VADM_17 to Adm2 (protected)

route main: VADM_17,Adm5,Adm2
route spare: VADM_17,VADM_18,VADM_15,VADM_16,Adm2
A switch connection is created on Adm2

route main: VADM_17,Adm5
route spare: VADM_17,VADM_18,VADM_15,VADM_16,Adm2,Adm5
leg4 - from VADM_17 to VADM_15 (protected)

route main: VADM_17,VADM_18,VADM_15
route spare: VADM_17,Adm5,Adm2,VADM_16,VADM_15
A switch connection is created on VADM_15

route main: VADM_17,VADM_18,VADM_15,VADM_16
route spare: VADM_17,Adm5,Adm2,VADM_16
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
route main: VADM_17,VADM_18
route spare: VADM_17,Adm5,Adm2,VADM_16,VADM_15,VADM_18
A switch connection is created on VADM_18 !
SETpath
allocRule user
implRule user
END
SET ntwId 2
END
CREATEpath
userLabel 'circular1'
pathRate lo2Mb
alarmPropRule whenCommissioned
userId 'lts4182/snmlr23'
pmAutomatic false
endTpList
nap 'VADM_17/2M-1-01'
usedDir source
nap 'VADM_17/2M-1-02'
usedDir sink
END
END
CONSTRpath
constraintSet "SetE"
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
ALLOCpath
END
Comments:
!! Leg2
! nap 'Adm2/port2M-101' is added to the path !
ADDLEGpath
END
CONSTRpath
constraintSet "SetF"
END
Comments:
!! Leg2 is allocated after the following command.

! A broadcast connection is created on node VADM_17 !
ADDLEGpath
allocRule automaticallyAllocated
deferred
END
CONSTRpath
constraintSet "SetG"
ctp 'VADM_17/West payloadPos '01/1/1.1'
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
Comments:
!! Leg2 is protected !
PROTECTpath
protect deferred
endTpList
nap 'VADM_17/2M-1-01'
topologyLevel ntw
END
END
Comments:
!! Leg3
ADDLEGpath
END
CONSTRpath
constraintSet "SetH"
END
Comments:

! A leg is added on the broadcast connection on node VADM_17 !
ADDLEGpath
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
deferred
END
CONSTRpath
constraintSet "SetM"
END
Comments:
PROTECTpath
protect deferred
endTpList
nap 'VADM_17/2M-1-01
topologyLevel ntw
END
END
Comments:
!! Leg4
! nap 'VADM_15/2M-1-01' is added to the path !
ADDLEGpath
nap 'VADM_15/2M-1-01'
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
CONSTRpath
constraintSet "SetN"
END
Comments:

ADDLEGpath
deferred
nap 'VADM_15/2M-1-01'
END
CONSTRpath
END
Comments:
PROTECTpath
protect deferred
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
endTpList
nap 'VADM_17/2M-1-01'
nap 'VADM_15/2M-1-01'
topologyLevel ntw
END
END
Comments:
!! Leg5
ADDLEGpath
nap 'VADM_16/2M-1-01'
END
CONSTRpath
constraintSet "SetO"
END
Comments:

ADDLEGpath
deferred
nap 'VADM_16/2M-1-01'
END
CONSTRpath
constraintSet "SetP"
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
Comments:
PROTECTpath
protect deferred
endTpList
nap 'VADM_17/2M-1-01'
nap 'VADM_16/2M-1-01'
topologyLevel ntw
END
Comments:
!! Leg6
ADDLEGpath
nap 'VADM_18/2M-1-01'
END
CONSTRpath
END
Comments:

ADDLEGpath
deferred
nap 'VADM_18/2M-1-01'
END
CONSTRpath
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
Comments:
!! Leg6 is protected!
PROTECTpath
protect deferred
endTpList
nap 'VADM_17/2M-1-01'
nap 'VADM_18/2M-1-01'
topologyLevel ntw
END
END
CONSTRpath
END
SPLITpath
operationalRule automatic
node "ADM0001"
END
JOINpath
userLabel "ADM0004"
node "ADM0001"
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
Trails Example
The following examples illustrate the network that is depicted in this figure:
Three trails are created and a LO connection is configured as follows:

1. trail trail8-29/1: Adm-8,Adm7,VADM_29
2. trail trail8-29/2: Adm-8,VADM_11,VADM_19,VADM_33,VADM_29
3. the last trail is SNCP protected:
trail trail_prot : VADM_42,VADM_40,VADM_41 main
trail trail_prot : VADM_42,VADM_39,VADM_41 spare
SET ntwId 3
END
Comments:
!! Trail 1!
CREATEtrail
userLabel 'trail8-29/1'
trailType pointToPoint
flow bidirectional
endTpList
ctp 'VADM_29/West' payloadPos '02'
ctp 'Adm8/East' payloadPos '02'
END
CONSTRtrail
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
ctp 'Adm7/West' payloadPos '02'
END
ALLOCtrail
END
CONSTRtrail
END
IMPLtrail
END
Comments:
!! Trail 1 is LO configured !
CONFIGtrail
payloadStructure tu12Tu12Tu3
END
Comments:
!! Trail 2 !
CREATEtrail
flow bidirectional
endTpList
ctp 'VADM_29/East' payloadPos '02'
END
END
CONSTRtrail
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
ALLOCtrail
END
CONSTRtrail
END
IMPLtrail
END
Comments:
CONFIGtrail
END
Comments:
!! Trail 3 !
CREATEtrail
userLabel 'trail-prot'
flow bidirectional
endTpList
END
END
CONSTRtrail
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
ALLOCtrail
END
Comments:
!! Trail 3 is SNCP protected !
CONSTRtrail
END
PROTECTtrail
protect deferred
endTpList
cap 'VADM_41/East' payloadPos '01'
cap 'VADM_42/West' payloadPos '01'
topologyLevel ntw END
END
CONSTRtrail
userLabel 'trail-prot’
END
IMPLtrail
END
Comments:
CONFIGtrail
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
SPLITtrail
node "ADM0001"
END
JOINtrail
userLabel "ADM0004"
operationalRule automatic node "ADM0001"
END
CONFIGUREmsTrail
userLabel "MSTRAIL-TO-TEST"
Au4List
hoAu4conc4 4
END
END
Example of a path that uses HO trails

This example shows three trails that were created in the previous example. An SNCP path
is implemented by using the trails.
The end points of the path are located on VADM_29 and VADM42.
SETpath
allocRule user
implRule user
END
SET ntwId 3
END
Comments:
!! The first unprotected path is created!
CREATEpath
userLabel 'test-mig'
pathRate lo2Mb
pmAutomatic false
endTpList
nap 'VADM_29/2M-01'
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
nap 'VADM42/2M-1'
END
END
Comments:
!! The path uses the trail 'trail8-29/1'.

! It is not necessary to define the TP on node Adm7
! because this TP belongs to the trail. !
CONSTRpath
constraintSet "SetX"
END
ALLOCpath
END
Comments:
!! The path is SNCP protected.

! The spare route uses the other two trails
! in the previous example !
CONSTRpath
constraintSet "AutomaticSystemSet"
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
PROTECTpath
protect deferred
endTpList
nap 'VADM_29/2M-01'
nap 'VADM42/2M-1'
topologyLevel ntw
END
END
CONSTRpath
END
IMPLpath
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
....................................................................................................................................................................................................................................
March 2011
4 Trail Management
4
Overview
Purpose
pertains to the CLI commands for trail management.
Contents
Trail Management 4-2

Trail Management: SET and UPDATE 4-3
Trail Management: CREATE and DELETE 4-4
Trail Management: CONSTR 4-5
Trail Management: ALLOC and DEALLOC 4-6
Trail Management: IMPL and DEIMPL 4-7
Trail Management: CONFIG and CONFIG 4-8
Trail Management: PROTECT 4-9
Trail Management: SPLIT and JOIN 4-10
Trail Management: Various Updates 4-11
...................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management
....................................................................................................................................................................................................................................
Trail Management
Available commands for the trail object
The following commands are available for trail management:
• “SET trail” (p. 4-3)
• “CREATE trail” (p. 4-4)
• “CONSTRtrail” (p. 4-5)
• “ALLOC trail” (p. 4-6)
• “DEALLOCtrail” (p. 4-6)
• “IMPL trail” (p. 4-7)
• “DEIMPL trail” (p. 4-7)
• “CONFIG trail” (p. 4-8)
• “DELETEtrail” (p. 4-4)
• “UPDATE trail” (p. 4-3)
• “PROTECT trail” (p. 4-9)
• “SPLIT trail” (p. 4-10)
• “JOIN trail” (p. 4-10)
• “UPDALR trail” (p. 4-11)
• “ELEMALRMNG trail” (p. 4-11)
• “CONFIGUREms Trail” (p. 4-8)
Extensive examples of paths and trails

Because of the interworking between paths and trails, Chapter 5, “Path Management and
Trail Management Examples” contains extensive examples on the CLI commands that are
used to create and manipulate paths and trails.
....................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management: SET and UPDATE
....................................................................................................................................................................................................................................
Trail Management: SET and UPDATE

SET trail
The SET trail command is used to set the default values for the attributes that are to be
specified at the trail creation time, which is the definition time.
SET trail parameter value options
upd_trail_attributes :=
{ trailType pointToPoint }
[ payloadStructure tu12Tu12Tu12 | payloadStructure tu12Tu12Tu3 |
payloadStructure tu12Tu3Tu12 | payloadStructure tu3Tu12Tu12 |
payloadStructure notTerminatedAu4 | payloadStructure
notTerminatedAu3
payloadStructure tu12 | payloadStructure notMeaningful ]
[ protType notProtected | protType sh1Plus1EToEProt | protType
enhanced Protected]
[ msProtProfile normal | msProtProfile protPref]
flow bidirectional
not_upd_trail_attributes:= [ sdhAlrEnabRule onImplementation
|sdhAlrEnabRule onCommissioning | sdhAlrEnabRule manual ]
trail_attributes:=
[ upd_trail_attributes | not_upd_trail_attributes ]
SET trail syntax
SET trail
<trail_attributes>
END
UPDATE trail
The UPDATEtrail command updates the attribute trails.
UPDATEtrail syntax
UPDATEtrail
updList
[<upd_trail_attributes>]
END
END
....................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management: CREATE and DELETE
....................................................................................................................................................................................................................................
Trail Management: CREATE and DELETE

CREATE trail
The CREATEtrail command defines a trail. If 'payloadStructure' attribute has a value
different from 'notMeaningful' (default value), 'notTerminatedAu4' and
'notTerminatedAu3', the trail is implemented and also configured.
CREATE trail parameter value options
ctp_list := ctp <port_name> position_attribute <string>

node_list := node <node_name>
end_tp_list := <ctp_list> <ctp_list> | <node_list> <node_list>
CREATEtrail syntax
CREATEtrail
userLabel <string>
[<trail_attributes>]
endTpList
<end_tp_list>
<end_tp_list>
END
END
DELETEtrail
The DELETEtrail command delete the trail.
DELETE trail syntax
DELETEtrail
END
....................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management: CONSTR
....................................................................................................................................................................................................................................
Trail Management: CONSTR

CONSTRtrail
The CONSTRtrail command defines constraints to correctly allocate a trail. If the
constraint list is void, it deletes all constraints previously defined on the trail.
CONSTRtrail parameter value options
ctp_constr_list := { ctp <port_name> position_attribute <string>

constrainType useMain | ctp <port_name> position_attribute <string>
constrainType useSpare | ctp <port_name> position_attribute <string>
constrainType notUseMain | ctp <port_name> position_attribute
<string>
constrainType notUseSpare | ctp <port_name> position_attribute
<string>
constrainType useMainSpare | ctp <port_name> position_attribute
<string>
constrainType notUse | ctp <port_name> position_attribute <string>
constrainType useService | ctp <port_name> position_attribute
<string>
constrainType notUseService }
CONSTR trail syntax
CONSTR trail
constraintSet "_AutomaticSystemSet_"
physicalConn userLabel "STM16_b25p1"
constraintType use section "spare"
END
....................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management: ALLOC and DEALLOC
....................................................................................................................................................................................................................................
Trail Management: ALLOC and DEALLOC

ALLOC trail
The ALLOC trail command allocates resources on defined trail.
ALLOC trail syntax
ALLOCtrail
END
DEALLOCtrail
The DEALLOC trail command deallocates resources on implemented trail.
DEALLOC trail syntax
DEALLOC trail
END
....................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management: IMPL and DEIMPL
....................................................................................................................................................................................................................................
Trail Management: IMPL and DEIMPL

IMPL trail
The IMPL trail command implements an allocated trail.
IMPL trail syntax
IMPL trail
END
DEIMPL trail
The DEIMPL trail command deimplements an implemented trail.
DEIMPL trail syntax
DEIMPL trail
END
....................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management: CONFIG and CONFIG
....................................................................................................................................................................................................................................
Trail Management: CONFIG and CONFIG

CONFIG trail
The CONFIG trail command configures the payload structure of trail.
CONFIG trail syntax
CONFIGtrail
[ payloadStructure tu12Tu12Tu12|payloadStructure tu12Tu12Tu3|
payloadStructure tu12Tu3Tu3 | payloadStructure tu3Tu12Tu3|
payloadStructure tu3Tu3Tu12 | payloadStructure tu3Tu3Tu3|
payloadStructure notTerminatedAu4|payloadStructure terminatedAu4 |
payloadStructure notMeaningful payloadStructure notTerminatedAu3 |
payloadStructure tu12]
END
CONFIGUREms Trail
The CONFIGUREMs trail command configure the payload of a MsTrail.
CONFIGUREms trail syntax
CONFIGUREms trail
Au4List [ hoAu4 | hoAu4conc4 | hoAu4conc16 | hoAu4conc64 ]
END
....................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management: PROTECT
....................................................................................................................................................................................................................................
Trail Management: PROTECT

PROTECT trail
The PROTECT trail command changes the protection on an existing trail.
PROTECT trail parameter value options
changeOpRes := keepingMain | keepingSpare
ttp_to_prot := cap <port_name> position_attribute <string> |

protCmd := protect | addEnhancedProt
remCmd := removeEnhancedProt | removeEnhancedProtWithCheck
unprCmd := unprotect | unprotectWithCheck

PROTECT trail syntax
The ttp_to_prot in a PROTECT trail command has to be on the boundary of a
topology. If the topology level is not specified, the trail is protected into the upper
topology level. Make enhancedProtected trails start from SNCP trails
(protType=sh1Plus1EToEProt), and then add the service protection with the proper
command.
PROTECT trail
<protCmd>
<changeOpType>
endTpList
[topologyLevel <topLev>]]
END
END
PROTECTtrail
{ <unprCmd> <changeOpRes> <changeOpType> | <remCmd> <changeOpType> }
endTpList
[topologyLevel <topLev>]]
END
END
....................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management: SPLIT and JOIN
....................................................................................................................................................................................................................................
Trail Management: SPLIT and JOIN

SPLIT trail
The SPLIT trail command splits an existing trail in two distinct trails.
SPLIT trail parameter value options
opRule := user | automatic

listJoinTp := node <user_label> |
[ node <user_label> ] nap <port_name1> nap <port_name2> |
[ node <user_label> ] cap <port_name1> position_attribute <string>
cap <port_name2> position_attribute <string> |
[ node <user_label> ] ctp <port_name1> position_attribute <string>
ctp <port_name2> position_attribute <string>
SPLIT trail syntax
SPLIT trail
<listJoinTp>
END
JOIN trail
The JOIN trail command joins two distinct trails.
JOIN trail syntax
JOINtrail
newLabel <new_label>
<listJoinTp>
END
....................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management: Various Updates
....................................................................................................................................................................................................................................
Trail Management: Various Updates

ELEMALRMNG trail
The ELEMALRMNG trail command enables/disables a Q3 SDH alarm.
ELEMALRMNG trail syntax
ELEMALRMNG trail
sdhElemAlr enable | sdhElemAlr disable
END
UPDALR trail
The UPDALR trail command is used to update the Q3 SDH alarm enabling rule.
UPDALR trail syntax
UPDALR trail
sdhAlrEnabRule manual | sdhAlrEnabRule onImplementation
END
....................................................................................................................................................................................................................................
March 2011
Trail Management Trail Management: Various Updates
....................................................................................................................................................................................................................................
....................................................................................................................................................................................................................................
March 2011
5 5ath Management and
P
Trail Management
Examples
Overview
Purpose
This chapter provides the 1350 OMS advanced user with the examples that pertains to the
CLI commands for path and trail management.
Contents
Network example 5-2

Bidirectional Path 5-3
Protected Paths with Drop and Continue 5-5
Broadcast Path 5-9
Trails example 5-21
Path that Uses HO Trails 5-26
...................................................................................................................................................................................................................................
March 2011
Path Management and Trail Management Examples Network example
....................................................................................................................................................................................................................................
Network example
Network example figure
The network that is illustrated in the following figure is depicted in these examples:
• “Bidirectional Path” (p. 5-3)
• “Protected Paths with Drop and Continue” (p. 5-5)
• “Broadcast Path” (p. 5-9)
In the following figure, NE_V1 is a virtual NE; all other ADMs are actual NEs.
....................................................................................................................................................................................................................................
March 2011
Path Management and Trail Management Examples Bidirectional Path
....................................................................................................................................................................................................................................
Bidirectional Path
Bidirectional path example
The following example illustrates the creation, allocation (by using constraints), and
implementation of a simple bidirectional 2Mb path between ADM_1 and VADM_2.
SETpath
allocRule user
implRule userallocationConstraint noRestriction
END
SET ntwId 1
END
CREATEpath
pathRate lo2Mb
userId "snmlr21"
pmAutomatic false
endTpList
nap "ADM_1/2M/1-09"
nap "VADM_3/2M-06"
END
END
Comments:
!! It is not necessary to define all constraints.

!! If the constaints are not defined, the routing algorithm
! chooses a route for the user.
! However, the routing algorithm uses all constraints
! that are related to the path when an
! allocation/add-remove leg/add-remove protection is executed !
CONSTRpath
ctp "ADM_1/West"
ctp "VADM_3/STM1-2"
END
CONSTRpath
....................................................................................................................................................................................................................................
March 2011
Path Management and Trail Management Examples Bidirectional Path
....................................................................................................................................................................................................................................
userLabel "Test 000 KL"
ctp "1660-12/STM16_2-100"
payloadPos "02/1"
trail userLabel "ne-60-1-vim VC4S15"
physicalConn
userLabel "1660-14/1660-7/stm16"
node userLabel "1660-8"
ctp "1660_6/r01s1b28p01"
payloadPos "02/1"
END
ALLOCpath
END
Comments:
! It is not necessary to remove all constraints related to the path.

! If the user does not delete them,
! the constraints are used for the next allocation phase
! userLabel "ADM001-VADM_3-2M-9"!
IMPLpath
END
CONNECTpath
"immediate"
endTpList
END
END
DISCONNECTpath
endTpList
END
END
....................................................................................................................................................................................................................................
March 2011
Path Management and Trail Management Examples Protected Paths with Drop and Continue
....................................................................................................................................................................................................................................
Protected Paths with Drop and Continue

Protected paths with drop and continue example
In the following example, an enhanced protected 2Mb path is implemented in three steps:
1. The unprotected path is implemented between Adm7 and Adm2. The path route is
forced by using TP constraints.
The route is Adm2-Adm5-VADM_2-VADM_3-Adm8-Adm7.
2. The path is SNCP protected. The spare path route is forced by using TP constraints.
The spare route is Adm2-VADM_16-VADM_15-VADM_38-VADM_34-VADM_4-
VADM_5-VADM_33-Adm7.
SNCP connections are created on Adm2 and Adm7.
3. The path is enhanced protected in RING STM-1 and RING STM-4. The service path
routes are forced by using TP constraints.
The first service route is Adm5-VADM_17-VADM_18-VADM_15. Drop & continue
connections are created on Adm5 and VADM_15.
The second service route is Adm8-VADM_11-VADM_19-VADM_33. Drop &
continue connections are created on Adm8 and VADM_33.
Comments:
!! Path enhanced protected !
SETpath
allocRule user
implRule user
END
SET ntwId 1
END
Comments:
!! Step 1- not protected path is created !
CREATEpath
pathRate lo2Mb
userId 'snmlr21'
endTpList
END
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
CONSTRpath
END
ALLOCpath
END
Comments:
!! Step 2 - protection SNCP is added !
CONSTRpath
constraintSet "Set_Y
tp 'VADM_5/STM1-1' payloadPos '01/1/1.3'
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
Comments:
!! The allocation of the spare route is executed

! with the following command!
PROTECTpath
protect deferred
endTpList
topologyLevel ntw
END
END
Comments:
!! Step 3 - service protection is added !
CONSTRpath
END
Comments:
!! The allocation of second spare route is executed

! with the following command !
PROTECTpath
endTpList
topologyLevel et
END
END
CONSTRpath
constraintSet "SetZ"
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
PROTECTpath
endTpList
topologyLevel et
END
END
CONSTRpath
END
....................................................................................................................................................................................................................................
March 2011
Path Management and Trail Management Examples Broadcast Path
....................................................................................................................................................................................................................................
Broadcast Path
In the following example, a broadcast path with two legs is created between VADM_38
and NE_V1 (virtual NE). The first leg is allocated and is also protected. On the second
leg, only the TP sink is defined. The first leg is created. Note that the sink is related by the
nodename and the portname. (To define only the nodename would be enough.) In this
example, the system selects the port and creates the virtual NAP. If necessary, the system
can create the virtual port.
SETpath
allocRule user
implRule user
END
SET ntwId 1
END
CREATEpath
userLabel "moni"
pathRate lo2Mb
userId "lts4182/snmlr24"
pmAutomatic false
endTpList
nap "VADM_38/2M-11"
usedDir source
node "NE_V1"
usedDir sink
portName "NE_V1/2M-21"
END
END
Comments:
!! Constraints are inserted; they are used during the

! allocation phase !
CONSTRpath
userLabel "moni"
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
ALLOCpath
userLabel "moni"
END
Comments:
!! Constraints are added to protect the first leg.

! Note the constraintType is useSpare now.
! The spare route is:
! VADM_38,VADM_34,VADM_37,X26,NE_V1
CONSTRpath
userLabel "moni"
ctp "VADM_38/STM1-2" payloadPos "01/2/7.3"
END
Comments:
!! The allocation of spare is executed by

! using the constraints. !
PROTECTpath
userLabel "moni"
protect deferred
endTpList
nap "VADM_38/2M-11"
nap "NE_V1/2M-21"
topologyLevel ntw
END
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
Comments:
!! Another leg is just defined !
ADDLEGpath
userLabel "moni"
node "NE_V1"
END

In this example, a broadcast path with six legs is allocated. Five legs are also SNCP
protected. The following figure illustrates the ring network and the routing of the legs in
the network.
Broadcast path 'circular 1'
leg1 - from VADM_17 to VADM_17 (not protected)

route: VADM_17,VADM_18,VADM_15,VADM_16,Adm2,Adm5,VADM_17

route main: VADM_17,Adm5,Adm2
route spare: VADM_17,VADM_18,VADM_15,VADM_16,Adm2

route main: VADM_17,Adm5
route spare: VADM_17,VADM_18,VADM_15,VADM_16,Adm2,Adm5

route main: VADM_17,VADM_18,VADM_15
route spare: VADM_17,Adm5,Adm2,VADM_16,VADM_15
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
route main: VADM_17,VADM_18,VADM_15,VADM_16
route spare: VADM_17,Adm5,Adm2,VADM_16

route main: VADM_17,VADM_18
route spare: VADM_17,Adm5,Adm2,VADM_16,VADM_15,VADM_18
A switch connection is created on VADM_18 !
SETpath
allocRule user
implRule user
END
SET ntwId 2
END
CREATEpath
pathRate lo2Mb
pmAutomatic false
endTpList
nap 'VADM_17/2M-1-01'
usedDir source
nap 'VADM_17/2M-1-02'
usedDir sink
END
END
CONSTRpath
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
ALLOCpath
END
Comments:
!! Leg2
ADDLEGpath
END
CONSTRpath
END
Comments:

! A broadcast connection is created on node VADM_17 !
ADDLEGpath
deferred
END
CONSTRpath
constraintSet "SetE"
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
ctp 'VADM_17/West payloadPos '01/1/1.1'
END
Comments:
PROTECTpath
protect deferred
endTpList
nap 'VADM_17/2M-1-01'
topologyLevel ntw
END
END
Comments:
!! Leg3
ADDLEGpath
END
CONSTRpath
constraintSet "SetF"
END
Comments:
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
ADDLEGpath
deferred
END
CONSTRpath
constraintSet "SetG"
END
Comments:
PROTECTpath
protect deferred
endTpList
nap 'VADM_17/2M-1-01
topologyLevel ntw
END
END
Comments:
!! Leg4
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
ADDLEGpath
nap 'VADM_15/2M-1-01'
END
CONSTRpath
END
Comments:

ADDLEGpath
deferred
nap 'VADM_15/2M-1-01'
END
CONSTRpath
END
Comments:
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
PROTECTpath
protect deferred
endTpList
nap 'VADM_17/2M-1-01'
nap 'VADM_15/2M-1-01'
topologyLevel ntw
END
END
Comments:
!! Leg5
ADDLEGpath
nap 'VADM_16/2M-1-01'
END
CONSTRpath
constraintSet "SetM"
END
Comments:

ADDLEGpath
deferred
nap 'VADM_16/2M-1-01'
END
CONSTRpath
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
Comments:
PROTECTpath
protect deferred
endTpList
nap 'VADM_17/2M-1-01'
nap 'VADM_16/2M-1-01'
topologyLevel ntw
END
Comments:
!! Leg6
ADDLEGpath
nap 'VADM_18/2M-1-01'
END
CONSTRpath
constraintSet "SetO"
END
Comments:

ADDLEGpath
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
deferred
nap 'VADM_18/2M-1-01'
END
CONSTRpath
END
Comments:
PROTECTpath
protect deferred
endTpList
nap 'VADM_17/2M-1-01'
nap 'VADM_18/2M-1-01'
topologyLevel ntw
END
END
CONSTRpath
END
SPLITpath
node "ADM0001"
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
JOINpath
userLabel "ADM0004"
node "ADM0001"
END
....................................................................................................................................................................................................................................
March 2011
Path Management and Trail Management Examples Trails example
....................................................................................................................................................................................................................................
Trails example
Trails example figure
The following examples illustrate the network that is depicted in this figure:
Three trails are created and a LO connection is configured as follows:

1. trail trail8-29/1: Adm-8,Adm7,VADM_29
2. trail trail8-29/2: Adm-8,VADM_11,VADM_19,VADM_33,VADM_29
3. the last trail is SNCP protected:
trail trail_prot : VADM_42,VADM_40,VADM_41 main
trail trail_prot : VADM_42,VADM_39,VADM_41 spare
SET ntwId 3
END
Comments:
!! Trail 1 !
CREATEtrail
flow bidirectional
endTpList
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
CONSTRtrail
END
ALLOCtrail
END
CONSTRtrail
END
IMPLtrail
END
Comments:
CONFIGtrail
END
Comments:
!! Trail 2 !
CREATEtrail
flow bidirectional
endTpList
END
END
CONSTRtrail
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
ALLOCtrail
END
CONSTRtrail
END
IMPLtrail
END
Comments:
CONFIGtrail
END
Comments:
!! Trail 3 !
CREATEtrail
flow bidirectional
endTpList
END
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
CONSTRtrail
END
ALLOCtrail
END
Comments:
!! Trail 3 is SNCP protected !
CONSTRtrail
END
PROTECTtrail
protect deferred
endTpList
cap 'VADM_41/East' payloadPos '01'
cap 'VADM_42/West' payloadPos '01'
topologyLevel ntw END
END
CONSTRtrail
userLabel 'trail-prot’
END
IMPLtrail
END
Comments:
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
CONFIGtrail
END
SPLITtrail
node "ADM0001"
END
JOINtrail
userLabel "ADM0004"
operationalRule automatic node "ADM0001"
END
CONFIGUREmsTrail
userLabel "MSTRAIL-TO-TEST"
Au4List
hoAu4conc4 4
END
END
....................................................................................................................................................................................................................................
March 2011
Path Management and Trail Management Examples Path that Uses HO Trails
....................................................................................................................................................................................................................................
Path that Uses HO Trails

Path that uses HO trails example
In this example, the three trails created in the previous example are used. An SNCP path
is implemented by using the trails.
The end points of the path are located on VADM_29 and VADM42.
SETpath
allocRule user
implRule user
END
SET ntwId 3
END
Comments:
!! First unprotected path is created !
CREATEpath
pathRate lo2Mb
pmAutomatic false
endTpList
nap 'VADM_29/2M-01'
nap 'VADM42/2M-1'
END
END
Comments:
!! The path uses the trail 'trail8-29/1'.

! It is not necessary to define the TP on node Adm7
! because this TP belongs to the trail.
CONSTRpath
constraintSet "SetX"
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
ALLOCpath
END
Comments:
!! The path is SNCP protected.

! The spare route uses the other two trails of the previous example.
CONSTRpath
constraintSet "SetY"
END
PROTECTpath
protect deferred
endTpList
nap 'VADM_29/2M-01'
nap 'VADM42/2M-1'
topologyLevel ntw
END
END
CONSTRpath
END
IMPLpath
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
....................................................................................................................................................................................................................................
March 2011
6 PM Management
6
Overview
Purpose
pertains to the CLI commands for management of Performance Monitoring (PM).
Contents
PM Management Overview 6-2

PM Management: SET 6-3
PM Management: pMeasure Object 6-4
PM Management: tCRProfile Object 6-6
PM Management: pmCountRep Object 6-8
PM Management: tCAProfile Object 6-10
PM Management: STARTmeas, STOPmeas, CONSmeas 6-11
PM Management: CORRtransToMeas and UNCORRtransToMeas 6-13
PM Management: CORRTpToMeas and UNCORRTpToMeas 6-14
PM Management: CORRrepToMeas and UNCORRrepToMeas 6-15
PM Management: CORRpmTpToTca and UNCORRpmTpToTca 6-16
PM Management: DELETEpmTp and DELETEpmTransp 6-17
Start/Stop PM on transport 6-18
...................................................................................................................................................................................................................................
March 2011
PM Management PM Management Overview
....................................................................................................................................................................................................................................
PM Management Overview
Available commands for PM management
The following verbs and objects are available for Performance Monitoring (PM)
management:
• “SET pmDomId” (p. 6-3)
• “CREATE CLASS pMeasure” (p. 6-4)
• “UPDATE CLASS pMeasure” (p. 6-4)
• “DELETE CLASS pMeasure” (p. 6-5)
• “CREATE CLASS tCRProfile” (p. 6-6)
• “UPDATE CLASS tCRProfile” (p. 6-7)
• “DELETE CLASS tCRProfile” (p. 6-7)
• “CREATE CLASS pmCountRep” (p. 6-8)
• “UPDATE CLASS pmCountRep” (p. 6-8)
• “DELETE CLASS pmCountRep” (p. 6-9)
• “CREATE CLASS tCAProfile” (p. 6-10)
• “DELETE CLASS tCAProfile” (p. 6-10)
• “STARTmeas” (p. 6-11)
• “STOPmeas” (p. 6-11)
• “CONSmeas” (p. 6-11)
• “CORRtransToMeas” (p. 6-13)
• “UNCORRtransToMeas” (p. 6-13)
• “CORRTpToMeas | UNCORRTpToMeas” (p. 6-14)
• “CORRrepToMeas | UNCORRrepToMeas” (p. 6-15)
• “CORRpmTpToTca” (p. 6-16)
• “UNCORRpmTpToTca” (p. 6-16)
• “DELETEpmTp” (p. 6-17)
• “DELETEpmTransp” (p. 6-17)
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: SET
....................................................................................................................................................................................................................................
PM Management: SET
SET pmDomId
The SET pmDomId command is used to set the performance monitoring Domain
(pmDomain). The default value of the pmDomain is read from the environment variable
NXNL_PMDOMAIN. The SET command can be used to assign a different value.
SET pmDomIdparameter value options
Tp := { nap <userLabel> | ctp <userLabel> payloadPos <pos> | cap

<userLabel> payloadPos <pos> } pathTrail := { pathUserLabel
<userLabel> | trailUserLabel <userLabel> }
TpList := [Tp] [TpList]
TransList := [pathTrail] [TransList]

SET pmDomId syntax
SET pmDomId <number>

END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: pMeasure Object
....................................................................................................................................................................................................................................
PM Management: pMeasure Object

CREATE CLASS pMeasure
The CREATE command is used to create a measure of performance (pMeasure) object.
CREATE CLASS pMeasure parameter value options
pmLay := lo | ho | bothLoHo
pmGran := pm24Hours | pm15Min
pmCount := false | true
defEnd := false | true

CREATE CLASS pMeasure syntax

pmGranularity <pmGran>
pmObjective {qos | maintenance | transportState | qosTc | mainTc}
pmCollectCounter <pmCount>
[ pmStartTime <date> ]
[ pmEndTime <date> ]
[ pmLayer <pmLay> ]
[ defaultEnd <boolean> ]
END
CREATE CLASS pMeasure example
The CREATE CLASS pMeasure command creates a measure named Measure_1.
Measure_1 is planned on 1350 OMS SDH but nothing happens during creation in the
network equipments. Measure_1 is active on network equipment between pmStartTime
and pmEndTime.

userLabel "Measure_1"
pmStartTime '2001/12/11-10:12:12'
pmEndTime '2002/12/11-10:12:12'
defaultEnd true
pmLayer ho
pmGranularity pm15Min
pmCollectCounter false
END
UPDATE CLASS pMeasure

The UPDATE command is used to set attribute values for one object of the same classes
specified for CREATE, which in this case is pMeasure.
UPDATE CLASS pMeasure syntax

....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: pMeasure Object
....................................................................................................................................................................................................................................
updList [ userLabel <user_label> ]
[ pmGranularity <pmGran> ]
[ pmLayer <pmLay> ]
[ pmCollectCounter <pmCount> ]
[ defaultEnd <defEnd> ]
[ pmStartTime <date> ]
[ pmEndTime <date> ]
END
END
DELETE CLASS pMeasure

The DELETE command is used to remove one object of the same classes specified for
CREATE, which in this case is pMeasure.
DELETE CLASS pMeasure syntax
DELETE CLASS pMeasure

END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: tCRProfile Object
....................................................................................................................................................................................................................................
PM Management: tCRProfile Object

CREATE CLASS tCRProfile
The CREATE command is used to create a threshold crossing report profile (tCRProfile)
object.
CREATE CLASS tCRProfile pMeasure parameter value options
pmRepDesType := file | mail | printer
pmRepWin := min15 | hour | day | week | month | year

CREATE CLASS tCRProfile syntax
When one of the non-mandatory attributes is not present in the following create request,
its value remains unspecified.

pmRepDestName <string>
pmReportWindow <pmRepWin>
[ pmReportDestType <pmRepDesType> ]
[ pmThreBBE <number> ]
[ pmThreES <number>
[ pmThreSES <number> ]
[ pmThreFEBBE <number> ]
[ pmThreFEES <number> ]
[ pmThreFESES <number> ]
END
CREATE CLASS tCRProfile example
Performance counters values can be checked against their overflowing a user-selected
edge and the results of this test can be sent by mail, print-out, or file. To create an object
class tCRProfile and to establish a liaison between this object and a measure are
illustrated in the following example:

userLabel 'Tcr_1'
pmGranularity pm15Min
pmReportDestType mail
pmRepDestName '/tmp/tcr_1.tmp'
pmReportWindow hour
pmThreBBE 10
pmThreES 10
END
CORRrepToMeas
userLabel 'Measure_1'
tcr 'Tcr_1'
END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: tCRProfile Object
....................................................................................................................................................................................................................................
The following command creates an object of class tCAProfile:
CREATE CLASS tCAProfile

pm15Min
pmTpForTca vc4
bBeHigh 10
bBeLow 1
END
An alarm will be produced if the bBe counter exceeds the range of specified values. To
make a Tca working it is necessary to correlate it to a Tp. An example follows:
CORRpmTpToTca
measureUserLabel 'Measure_1'
nap 'ADM_1-04'
tca 'Tca_1'
END
UPDATE CLASS tCRProfile

specified for CREATE, which in this case is tCRProfile.
UPDATE CLASS tCRProfile syntax
UPDATE CLASS tCRProfile

userLabel <user_label> updList
[ userLabel <user_label> ]
[ pmReportDestType <pmRepDesType>]
[ pmReportDestName <string> ]
[ pmReportWindow <pmRepWin> ]
[ pmThreBBE <number> ]
[ pmThreES <number>
[ pmThreSES <number> ]
[ pmThreFEBBE <number> ]
[ pmThreFEES <number> ]
[ pmThreFESES <number> ]
END
END
DELETE CLASS tCRProfile

CREATE, which in this case is tCRProfile.
DELETE CLASS tCRProfile syntax
DELETE CLASS tCRProfile

END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: pmCountRep Object
....................................................................................................................................................................................................................................
PM Management: pmCountRep Object

CREATE CLASS pmCountRep
The CREATE command is used to create a performance monitoring counter report
(pmCountRep) object.
CREATE CLASS pmCountRep syntax
CREATE CLASS pmCountRep

pmRepDestName <string>
pmReportWindow <pmRepWin>
pmReportDestType <pmRepDesType>
END
CREATE CLASS pmcountRep example
When a measure is bound to a path, a trail and its termination points, that relationship can
be un-bound using the UNCORRtransToMeas and UNCORRTpToMeas commands.
Performance counters values can be reported through mail, a printout, or a file. This
action is achieved by creating a new object of class pmCountRep and then correlating it
to one measure. The following sets of command illustrate this example:
CREATE CLASS pmcountRep

userLabel 'CountRep_1'
pmReportDestType file
pmRepDestName '/tmp/rep_1.tmp'
pmReportWindow day
END
CORRrepToMeas
countRep 'CountRep_1'
END
UPDATE CLASS pmCountRep

specified for CREATE, which in this case is pmCountRep.
UPDATE CLASS pmCountRep syntax
UPDATE CLASS pmCountRep

updList [ userLabel <userLabel> ]
[ pmReportDestType <pmRepDesType> ]
[ pmRepDestName <string> ]
[ pmReportWindow <pmRepWin> ]
END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: pmCountRep Object
....................................................................................................................................................................................................................................
DELETE CLASS pmCountRep
CREATE, which in this case is pmCountRep.
DELETE CLASS pmCountRep syntax
DELETE CLASS pmCountRep

END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: tCAProfile Object
....................................................................................................................................................................................................................................
PM Management: tCAProfile Object

The CREATE command is used to create a threshold crossing alarm profile (tCAProfile)
(pmCountRep) object.
CREATE CLASS tCAProfile syntax

pmTpForTCA <pmTpTca>
[ bBeHigh <number> ]
[ bBeLow <number> ]
[ eSHigh <number> ]
[ eSLow <number> ]
[ sESHigh <number> ]
[ sESLow <number> ]
[ fEBBEHigh <number> ]
[ fEBBELow <number> ]
[ fEESHigh <number> ]
[ fEESLow <number> ]
[ fESESHigh <number> ]
[ fESESLow <number> ]
END
DELETE CLASS tCAProfile

CREATE, which in this case is tCAProfile.
DELETE CLASS tCAProfilep syntax
DELETE CLASS tCAProfile

END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: STARTmeas, STOPmeas, CONSmeas
....................................................................................................................................................................................................................................
PM Management: STARTmeas, STOPmeas, CONSmeas

STARTmeas
The STOPmeas command is used to stop measurements.
The STARTmeas command is used to start measurements.
STARTmeas syntax
STARTmeas
[TpList | TransList]
END
STARTmeas example
STARTmeas
userLabel “PM 24H for path Test 000 KL”
nap "1660-12/34M-1-03"
ctp "1660_5/r01s1b12p01" payloadPos "02/1"
END
To activate the CREATE CLASS pMeasure command manually, the STARTmeas command
is used:
STARTmeas
END
STOPmeas
STOPmeas syntax
STOPmeas
END
STOPmeas example
To stop the CREATE CLASS pMeasure command manually, the STARTmeas command is
used:
STOPmeas
END
CONSmeas
The CONSmeas command is used to check the consistency of a measurement.
CONSmeas syntax
CONSmeas
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: STARTmeas, STOPmeas, CONSmeas
....................................................................................................................................................................................................................................
END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: CORRtransToMeas and UNCORRtran-
sToMeas
....................................................................................................................................................................................................................................
PM Management: CORRtransToMeas and UNCORRtransToMeas

CORRtransToMeas
The CORRtransToMeas command is used to correlate a measure to one or more
paths/trails.
CORRtransToMeas parameter value options
pathTrail:= [ pathUserLabel <user_label> |

trailUserLabel <user_label> ]
CORRtransToMeas syntax
CORRtransToMeas
measureUserLabel <user_label>
<pathTrail> ...
END
CORRtransToMeas example
An aim of performance measurement is to describe the quality of service that is offered
by a path or a trail. Therefore, once a path or trail is created, a measurement must be
correlated to the newly created path or trail. A correlation request can be submitted as
follows:
CORRtransToMeas
measureUserLabel "Measure_1"
pathUserLabel "ADM_1-ADM_39"
END
UNCORRtransToMeas
The UNCORRtransToMeas command is used to delete the correlation of a path/trail to one
or more measures.
UNCORRtransToMeas syntax
UNCORRtransToMeas
{ measureUserLabel <user_label> }...
<pathTrail>
END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: CORRTpToMeas and UNCORRTpToMeas
....................................................................................................................................................................................................................................
PM Management: CORRTpToMeas and UNCORRTpToMeas

CORRTpToMeas | UNCORRTpToMeas
The CORRTpToMeas command is used to correlate a termination point object (nap, cap,
ctp) to one or more measures.
For the CORRTpToMeas command, only measures with the same state can be specified.
CORRTpToMeas | UNCORRTpToMeas syntax
CORRTpToMeas | UNCORRTpToMeas
measureUserLabel <user_label> ...
<Tp>
END
CORRTpToMeas example
The end termination points of the object correlated automatically result under measure if
the attribute defaultEnd was set to true at the measure creation time. To have a more
detailed monitoring of the performance of a path or trail, another path or trail termination
point can be correlated to the measure as illustrated in the following example:
CORRTpToMeas
measureUserLabel "Measure_1"
nap "ADM_1-04"
END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: CORRrepToMeas and UNCORRrepToMeas
....................................................................................................................................................................................................................................
PM Management: CORRrepToMeas and UNCORRrepToMeas

CORRrepToMeas | UNCORRrepToMeas
The CORRrepToMeas command is used to correlate one or more reports (objects of class
pmCountRep or tCRProfile) to one or more measures.
The UNCORRrepToMeas command is used to remove the correlation between of one or
more reports and a measure.
CORRrepToMeas | UNCORRrepToMeas parameter value options
Report := tcr <user_label> | countRep <user_label>

CORRrepToMeas | UNCORRrepToMeas syntax
CORRrepToMeas | UNCORRrepToMeas
{ <Report> }...
END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: CORRpmTpToTca and UNCORRpmTpToTca
....................................................................................................................................................................................................................................
PM Management: CORRpmTpToTca and UNCORRpmTpToTca

CORRpmTpToTca
The CORRpmTpToTca command is used to correlate a performance monitoring
termination point (pmTp) to one or more tCAProfile objects.
CORRpmTpToTca syntax
The pmTp involved in the correlation is identified by the measure to which it belongs and
by the Tp to which it is related.
CORRpmTpToTca
<Tp>
{ tca <user_label> } ...
END
CORRpmTpToTca example
An alarm is produced if the bBe counter exceeds the range of specified values. To make a
Tca work, it must be correlated to a Tp, which is illustrated in the following example:
CORRpmTpToTca
nap 'ADM_1-04'
tca 'Tca_1'
END
UNCORRpmTpToTca
The UNCORRpmTpToTca command is used to delete the correlation of a pmTp to a
tCAProfile objects.
UNCORRpmTpToTca syntax
UNCORRpmTpToTca
<Tp>
END
....................................................................................................................................................................................................................................
March 2011
PM Management PM Management: DELETEpmTp and DELETEpmTransp
....................................................................................................................................................................................................................................
PM Management: DELETEpmTp and DELETEpmTransp

DELETEpmTp
DELETEpmTp syntax
The pmTp involved in the deletion is identified by the measure to which it belongs and by
the Tp to which it is related.
DELETEpmTp
<Tp>
END
DELETEpmTransp
DELETEpmTransp syntax
The DELETEpmTransp <pathTrail> specifies the userLabel of the pmTransport object. If
the pmTransport is a path-image, the pathUserLabel token is used. If the pmTransport is a
trail-image, the trailUserLabel is used.
A pmTransport is created with the same userLabel of the corresponding path/trail.
DELETEpmTransp
<pathTrail>
END
....................................................................................................................................................................................................................................
March 2011
PM Management Start/Stop PM on transport
....................................................................................................................................................................................................................................
Start/Stop PM on transport
STARTPMpath
The scope of this command is to start PM measurement on a path.
syntax
STARTPMpath
userLabel "…"
granularity …..
objective …..
END
STOPPMpath
The scope of this command is to stop PM measurement on a path.
syntax
STOPPMpath
userLabel "…"
END
STARTPMtrail
The scope of this command is to start PM measurement on a trail.
syntax
STARTPMtrail
userLabel "…"
granularity …..
objective …..
END
STOPPMtrail
The scope of this command is to stop PM measurement on a trail.
syntax
STOPPMtrail
userLabel "…"
END
....................................................................................................................................................................................................................................
March 2011
7 ASAP Management
7
Overview
Purpose
pertains to the CLI commands for ASAP management.
Contents
ASAP Management Overview 7-2

ASAP Management: CREATE CLASS aSAProfile and DELETE CLASS 7-3
aSAProfile
ASAP Management: CORRtoaSAProfile 7-5
...................................................................................................................................................................................................................................
March 2011
ASAP Management ASAP Management Overview
....................................................................................................................................................................................................................................
ASAP Management Overview

Available commands for ASAP management
The following verbs and objects are available for Alarm Severity Assignment Profile
(ASAP) management:
• “CREATE CLASS aSAProfile” (p. 7-3)
• “DELETE CLASS aSAProfile” (p. 7-4)
• “CORRtoaSAProfile” (p. 7-5)
The object of the class aSAProfile can be created and associated to other objects of the
class path, trail, and physicalConn. The following examples illustrate the importance and
the interrelationship of these alarms.
General
The objects of the class aSAProfile are handled with the following commands and
objects:
• The CREATE CLASS command is used to create one object.
• The UPDATE CLASS command is used to change one object attribute value.
• The DELETE CLASS command is used to remove one object.
• The CORRtoaSAProfile command is used to bind one object of the class aSAProfile
with the objects if a class, path, trail, or physical connection
....................................................................................................................................................................................................................................
March 2011
ASAP Management ASAP Management: CREATE CLASS aSAProfile and DELETE
CLASS aSAProfile
....................................................................................................................................................................................................................................
ASAP Management: CREATE CLASS aSAProfile and DELETE

CLASS aSAProfile
CREATE CLASS aSAProfile
The CREATE command is used to create one object.
CREATE parameter value options
AlarmSevCode:= nonAlarmed | minor | major | critical | warning

CREATE syntax

[ mediaEqFail <AlarmSevCode> ] >
[ underProtDegr <AlarmSevCode> ]
[ rSFailure <AlarmSevCode> ]
[ exBer <AlarmSevCode> ]
[ degSignal <AlarmSevCode>
[ confMismatch <AlarmSevCode> ]
[ sdhFailure <AlarmSevCode> ]
[ pdhFailure <AlarmSevCode> ]
[ qualityTC15 <AlarmSevCode> ]
[ qualityTC24 <AlarmSevCode>
END
Alarm Severity Code Defaults for Optional Attributes

Optional Attribute Alarm Severity Code Default
mediaEqFail major
underProtDegr warning
rSFailure major
exBer major
confMismatch major
sdhFailure major
pdhFailure warning
qualityTC15 minor
qualityTC24 minor
CREATE CLASS aSAProfile example

userLabel 'asap_1'
mediaEqFail major
underProtDegr warning
rSFailure major
exBer major
....................................................................................................................................................................................................................................
March 2011
ASAP Management ASAP Management: CREATE CLASS aSAProfile and DELETE
CLASS aSAProfile
....................................................................................................................................................................................................................................
degSignal warning
confMismatch major
sdhFailure warning
pdhFailure warning
qualityTC15 major
qualityTC24 minor
END
DELETE CLASS aSAProfile

The DELETE command is used to remove one object.
DELETE syntax
DELETE CLASS aSAProfile

END
....................................................................................................................................................................................................................................
March 2011
ASAP Management ASAP Management: CORRtoaSAProfile
....................................................................................................................................................................................................................................
ASAP Management: CORRtoaSAProfile

CORRtoaSAProfile
The CORRtoaSAProfile command is used to bind one object of the class aSAProfile with
the objects of a class path, trail, or physical connection
CORRtoaSAProfile parameter value options
asapClasses:= path | trail | physicalConn

objectUserLabel:= userLabel <user_label>
toBindObject:= CLASS
asapClasses { objectUserLabel }....
CORRtoaSAProfile syntax
CORRtoaSAProfile
{ toBindObject } ...
END
CORRtoaSAProfile example
CORRtoaSAProfile userLabel 'asap_1'

CLASS physicalConn
userLabel 'connec_1'
userLabel 'connec_2'
END
CLASS path example
CLASS path
userLabel 'path_1'
END
CLASS trail example
CLASS trail
userLabel 'trail_1'
END
END
....................................................................................................................................................................................................................................
March 2011
ASAP Management ASAP Management: CORRtoaSAProfile
....................................................................................................................................................................................................................................
....................................................................................................................................................................................................................................
March 2011
8 8estoration Rule
R
Management
Overview
Purpose
pertains to the CLI commands for management of restoration rule (restRule).
Contents
Restoration Rule Management Overview 8-2

Restoration Rule: SET restDomId 8-3
Restoration Rule: CREATE, UPDATE, DELETE 8-4
Restoration Rule: ACT_UPDATE CLASS ObjRestRule 8-6
...................................................................................................................................................................................................................................
March 2011
Restoration Rule Management Restoration Rule Management Overview
....................................................................................................................................................................................................................................
Restoration Rule Management Overview

Available commands for Restoration Rule management
The following verbs and objects are available for Restoration Rule management:
• “SET restDomId ” (p. 8-3)
• “CREATE CLASS restRule” (p. 8-4)
• “UPDATE CLASS restRule” (p. 8-4)
• “DELETE CLASS restRule” (p. 8-5)
• “ACT_UPDATE” (p. 8-6)
The object of the class aSAProfile can be created and associated to other objects of the
class path, trail, and physicalConn. The following examples illustrate the importance and
the interrelationship of these alarms.
....................................................................................................................................................................................................................................
March 2011
Restoration Rule Management Restoration Rule: SET restDomId
....................................................................................................................................................................................................................................
Restoration Rule: SET restDomId

SET restDomId
The SET restDomId command is used to set the working restoration domain, which is the
restoration domain to which all subsequent commands that are related to the object of the
class restoration Rule are sent.
SET restDomId syntax
SET restDomId <number>

END
....................................................................................................................................................................................................................................
March 2011
Restoration Rule Management Restoration Rule: CREATE, UPDATE, DELETE
....................................................................................................................................................................................................................................
Restoration Rule: CREATE, UPDATE, DELETE

CREATE CLASS restRule
The CREATE CLASS restRule command is used to create one object class.
CREATE parameter value options
ObjRestClass:= path | trail

RestorationStrategy:= optimizedAddProt | eToEAddProt
AllocationConstraint:= notAlarmedResourcesOnly | noRestriction
ConstrRule:= dontUseConstraints | useDefConstraints
CREATE CLASS restRule syntax
In this CREATE CLASS restRule request , holdOffTime has a value of 300 as a default.
In this CREATE CLASS restRule request, the object of the class restoration rule is
identified by the user label and the class of the related object.

objClass <ObjRestClass>
[ restStrategy <RestorationStrategy> ]
[ holdOffTime <number> ]
[ usedResources <AllocationConstraint> ]
[ constraintRule <ConstrRule> ]
END
CREATE CLASS restRule syntax
The following command creates an object of the class restoration rule that is related to an
object of the class path that is identified by its user label 'path_1'.

userLabel 'path_1'
objClass path
END
UPDATE CLASS restRule

The UPDATE CLASS restRule command is used to change one object class attribute value.
UPDATE CLASS restRule syntax
In this UPDATE CLASS restRule request, the object of the class restoration rule is

updList
[ restStrategy <RestorationStrategy> ]
[ holdOffTime <number> ]
[ usedResources <AllocationConstraint> ]
....................................................................................................................................................................................................................................
March 2011
Restoration Rule Management Restoration Rule: CREATE, UPDATE, DELETE
....................................................................................................................................................................................................................................
[ constraintRule <ConstrRule> ]
END
END
UPDATE CLASS restRule example
The following example illustrates that the restoration rule object that was just created
changes its attribute values:

userLabel 'path_1'
objClass path
updList
holdOffTime 500
END
END
DELETE CLASS restRule

The DELETE CLASS restRule command is used to remove one object.
DELETE CLASS restRule syntax
In this DELETE CLASS restRule request, the object of the class restoration rule is
DELETE CLASS restRule

END
....................................................................................................................................................................................................................................
March 2011
Restoration Rule Management Restoration Rule: ACT_UPDATE CLASS ObjRestRule
....................................................................................................................................................................................................................................
Restoration Rule: ACT_UPDATE CLASS ObjRestRule

ACT_UPDATE
The ACT_UPDATE command is used to change the attribute restState for one object of a
class path or trail.
ACT_UPDATE syntax
ACT_UPDATE CLASS ObjRestClass

updList restState supervised
END
END
ACT_UPDATE CLASS ObjRestRule example
The following example illustrates if the attribute restStat value for the object of the class
path or trail must be changed:
ACT_UPDATE CLASS ObjRestRule

userLabel 'path_1'
updList
restState supervised
END
END
....................................................................................................................................................................................................................................
March 2011
9 Connection Management
9
Overview
Purpose
pertains to the CLI commands for connection management.
Contents
Connection Management 9-2

Connection Management: IMPL and DEIMPL 9-3
Connection Management: MNGRawConn 9-5
Connection Management: CREATE and DELETE 9-6
...................................................................................................................................................................................................................................
March 2011
Connection Management Connection Management
....................................................................................................................................................................................................................................
Connection Management
Available commands for connection management
The following verbs and objects are available for connection management:
• “IMPL conn and DEIMPL conn” (p. 9-3)
• “MNGRawConn” (p. 9-5)
• “CREATE conn” (p. 9-6)
• “DELETE conn” (p. 9-6)
....................................................................................................................................................................................................................................
March 2011
Connection Management Connection Management: IMPL and DEIMPL
....................................................................................................................................................................................................................................
Connection Management: IMPL and DEIMPL

IMPL conn and DEIMPL conn
The IMPL conn and DEIMPL conn commands can be used to implement (IMPL) and
deimplement (DEIMPL) a connection in a particular topology.
IMPL conn and DEIMPL conn parameter value options
tpRole+value: = { RCV | RCV Main | RCV Spare | XMIT Main | XMIT

Spare | XMIT Main RCV Main | XMIT Main RCV Spare | XMIT Spare RCV
Main XMIT Spare RCV Spare | XMIT RCV | XMIT Main RCV | XMIT Spare
RCV | XMIT RCV Main | XMIT RCV Spare | XMIT Service RCV Service |
XMIT Service | RCV Service }
tp:= { ctp <port_name> position_attribute <string> tpRole <tpRole_

value> | nap <port_name> tpRole <tpRole_value> | cap <port_name>
position_attribute <string> tpRole <tpRole_value> }
conn_tp_list:= { <tp> <tp> [tp] [tp] }
topolevel:= { ntw | sbn | et | node }
For tp: = the possible ctp, nap, cap configurations are:

ctp-ctp ctp-ctp-ctp ctp-ctp-ctp-ctp
nap-ctp nap-ctp-ctp cap-ctp-ctp-ctp
ctp-nap ctp-ctp-nap ctp-cap-ctp-ctp
cap-ctp cap-cap-cap ctp-ctp-cap-ctp
ctp-cap cap-ctp-ctp ctp-ctp-ctp-cap
cap-ca nap-ctp-ctp-ctp
nap-nap ctp-nap-ctp-ctp
ctp-ctp-nap-ctp
ctp-ctp-ctp-nap
IMPLconn syntax
IMPLconn
topologyLevel <topolevel>
endTPList
<conn_tp_list>
END
END
DEIMPLconn syntax
DEIMPLconn
topologyLevel <topolevel>
endTPList
<conn_tp_list>
....................................................................................................................................................................................................................................
March 2011
Connection Management Connection Management: IMPL and DEIMPL
....................................................................................................................................................................................................................................
END
END
IMPL conn example
IMPL conn
topologyLevel node
endTpList
cap 'ADM5/West' payloadPos '01' tpRole 'XMIT RCV'
cap 'VADM_17/East' payloadPos '01' tpRole 'XMIT RCV'
END
DEIMPL conn example
DEIMPL conn
topologyLevel node
endTpList
cap 'ADM5/West' payloadPos '01' tpRole 'XMIT RCV'
cap 'VADM_17/East' payloadPos '01' tpRole 'XMIT RCV'
END
END
....................................................................................................................................................................................................................................
March 2011
Connection Management Connection Management: MNGRawConn
....................................................................................................................................................................................................................................
Connection Management: MNGRawConn

MNGRawConn
The MNGRawConn command can be used to manage raw connections (MNGRawConn).
MNGRawConn parameter value options
position_attribute := payloadPos | wdmFrequency
objElementList := <objElement> [ objElementList ]
objElement := objLC | objRawConn | tpList
objLC := lc userLabel <user_label> position_attribute "string"
objRawConn := rawConn userLabel <user_label>
tpList := endTpList <tpElement> <tpElement> [tpElement] END
tpElement := ctp <port_name> position_attribute <string> tpRole

<tpRole_value> | cap <port_name> position_attribute <string>
tpRole <tpRole_value> | nap <port_name> tpRole <tpRole_value>
flState := noTransp | rawConn | pathTrail | trailConf
actType := add | remove | convert

MNGRawConn syntax
MNGRawConn
<objElementList>
finalState <flState>
actionType <actType>
[pathLabel <name>]
END
....................................................................................................................................................................................................................................
March 2011
Connection Management Connection Management: CREATE and DELETE
....................................................................................................................................................................................................................................
Connection Management: CREATE and DELETE

CREATE conn
The CREATE conn command can be used to create a connection in a particular topology.
CREATE conn parameter value options
role_value := main | spare | rel | sink | source
roles := role <role_value>
tpRoles := tpRole <tpRole_value>
tpElement := ctp <port_name> position_attribute <string>

[tpRoles | roles] | cap <port_name> position_attribute <string>
[tpRoles | roles] | nap <port_name> [tpRoles | roles] | cap
CREATE conn syntax
CREATEconn
[nextAct { none | calcRawConn | calcRawConnTrans | calcRawTransConf
}]
[confSt { allocated | defined | implemented | notMeaningful |
partiallyImplemented | commissioned }]
[virtual { normal | virtual }]
[connType { bridge | bridgeAndSwitch | broadcast | pointToPoint|

switch | openSNCP | dropAndCont | joint | dropAndCont2Sw |
dropAndContOneNode }]
[flow { bidirectional | unidirectional | notMeaningful }]
[connAccepted { notAcknowledged | acknowledged | notPresentInNe }]
[operationMode { revertive | nonRevertive | unknown | notMeaningful

}]
[dropContMode { dcnormal | dcinverse }]
[connFlexibilityLevel { flexible | fixed | semiFixed }]

END
DELETE conn
The DELETE conn command can be used to delete a connection in a particular topology.
DELETE conn parameter value options
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
tpElement := ctp <port_name> position_attribute <string>
tpRole <tpRole_value> | cap <port_name> position_attribute <string>
tpRole <tpRole_value> | nap <port_name> tpRole <tpRole_value>
DELETEconn syntax
DELETE conn
<tpList>
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
....................................................................................................................................................................................................................................
March 2011
10 Topology Management
10
Overview
Purpose
pertains to the CLI commands for topology management.
Contents
Topology Management Overview 10-2

Topology Management: CREATE and REMOVE 10-3
Topology Management: IMPL, DEIMPL, and UPDATE 10-9
Topology Management: SPLIT, JOIN, and OBJECT 10-12
...................................................................................................................................................................................................................................
March 2011
Topology Management Topology Management Overview
....................................................................................................................................................................................................................................
Topology Management Overview

Topology management commands
The topology management commands include the following:
• The CREATE commands are used to create a new topology.
The CREATE commands include the following.
– CREATEntw is used to create a new network topology (ntw).
– CREATEsbn is used to create a new subnetwork (sbn).
– CREATEet is used to create a new elementary topology (et).
– CREATEnode is used to create a new node.
– CREATE physicalConnection is used to create a new physical connection
• The REMOVE commands are used to remove a previously created (an existing)
topology.
The REMOVE commands include the following.
– REMOVEntw is used to remove an existing network topology (ntw).
– REMOVEsbn is used to remove an existing subnetwork (sbn).
– REMOVEet is used to remove an existing elementary topology (et).
– REMOVEnode is used to remove an existing node.
– REMOVE physicalConnection is used to remove an existing physical connection
• The IMPL commands are used to implement a topology.
The IMPL commands include the following:
– IMPLntw is used to implement a network topology (ntw).
– IMPLsbn is used to implement a subnetwork (sbn).
– IMPLet is used to implement a elementary topology (et).
– IMPL physicalConnection is used to implement a physical connection
• The DEIMPL commands are used to deimplement a previously implemented topology.
The DEIMPL commands include the following:
– DEIMPLntw is used to deimplement a network topology (ntw).
– DEIMPLsbn is used to deimplement a subnetwork (sbn).
– DEIMPLet is used to deimplement a elementary topology (et).
– DEIMPL physicalConnection is used to deimplement a physical connection
• The Update et command is used to update the globalCfg attribute in the elementary
topology (et).
• The SPLIT and JOIN commands are used to manipulate physical connections.
The SPLIT and JOIN commands include the following:
– SPLITphysicalConnection is used to split a defined physical connection.
– JOINphysicalConnection is used to join two physical connections.
• The OBJECTconnection command is used to connect and/or disconnect one or more
physical connections.
....................................................................................................................................................................................................................................
March 2011
Topology Management Topology Management: CREATE and REMOVE
....................................................................................................................................................................................................................................
Topology Management: CREATE and REMOVE

Available commands for CREATE and REMOVE topology
The following verbs and objects are available for CREATE and REMOVE topology:
• “CREATEntw” (p. 10-3)
• “CREATEsbn” (p. 10-3)
• “CREATEet” (p. 10-6)
• “CREATEnode” (p. 10-4)
• “CREATEphysicalConn” (p. 10-4)
• “REMOVEntw” (p. 10-6)
• “REMOVEsbn” (p. 10-6)
• “REMOVEet” (p. 10-7)
• “REMOVEnode” (p. 10-7)
• “REMOVEphysicalConnection” (p. 10-7)
CREATEntw
The CREATEntw command can be used to create a network (ntw) topology.
The order in which the parameters are presented on the command line is not important for
a CREATE operation.
CREATEntw parameter value options
etType_set:= genericRing | msSpring | meshed | msSpring4F
stmType_set:= stm1 | stm4 | stm16 | notHomogeneous | stm64 | stm0

CREATEntw syntax
CREATEntw
userID <string>
[comment1 <string>]
[comment2 <string>]
END
CREATEsbn
The CREATEsbn command can be used to create a subnetwork (sbn) topology.
a CREATE operation.
CREATEsbn syntax
CREATEsbn
includedIn ntw <type>
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
userID <string>
[comment1 <string>]
[comment2 <string>]
END
CREATEsbn syntax
CREATEsbn
includedIn ntw 'ntw1'
userLabel 'sbn1'
userId 'snml1'
comment1 'Test to create a subnetwork'
comment2 'Test passed'
END
CREATEnode
The CREATEnode command can be used to create a node topology.
a CREATE operation.
CREATEnode parameter value options
etType_set:= genericRing | msSpring | meshed | msSpring4F
stmType_set:= stm1 | stm4 | stm16 | notHomogeneous | stm64 | stm0

CREATEnode syntax
CREATEnode
includeIN <sbn| et> <user_label>
userID <string>
neUserLabel <user_label>
[comment1 <string>]
[comment2 <string>]
[imType {virtual | senIM | tsdIM}]
[siteName <string>]
END
CREATE node example
CREATE node
includedIn sbn 'sbn1'
neUserLabel 'ne1'’
userLabel 'node1'
userId 'snml1'
comment1 'Test to create a network'
comment2 'Test passed''
END
CREATEphysicalConn
The CREATEphysicalConn command can be used to create a physical connection.
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
a CREATE operation.
CREATEphysicalConn parameter value options
ptech := { sdh | wdm }
tptype := { ops0 | ots | stm1 | stm4 .... }

<for more see SG_PortType and SG_WdmPortType.>
aPort := [aSDHPort <port_name] |

[aVirtualNode <node_name> portName <port_name>
portTechno <ptech> portType <tptype>]
zPort := [zSDHPort <port_name] |

[zVirtualNode <node_name> portName <port_name>
portTechno <ptech> portType <tptype>]
CREATEphysicalConn syntax for A/Z Ports
CREATEphysicalConnection
userId <string>
aPort
zPort
END
CREATEphysicalConn syntax for a new PO/NT node:
CREATEphysicalConnection
userId <string>
ntNode <node_name>
END
CREATE physicalConnection example 1
CREATE physicalConnection'
userLabel 'phyConn1''
userId 'snml1''
aSDHPort 'portWest1''
zSDHPort 'portEast1''
END
CREATE physicalConnection example 2
CREATE physicalConnection'
userLabel "Physical Conn Fox I/1660_12"
userId "snml@tvhiz"
aVirtualNode "Virtual Fox I"
portName "Port I Fox I/stm16" portTechno sdh portType stm16
zSDHPort "1660-12/STM-16_2-102"
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
CREATEet
The CREATEet command can be used to create an elementary topology (et).
a CREATE operation.
CREATEet syntax
CREATEet
include IN sbn <sbn type>
userId <string>
etType <type>
stmType <type>
fiberNum <num>
globalCfg <True/False>
[comment1 <string>]
[comment2 <string>]
END
CREATEet example
CREATE et
includedIn sbn 'sbn1'
userLabel 'et1'
userId 'snml1'
etType genericRing
stmType stm1
fiberNum 2
globalCfg True
comment1 'Test to create a network'
comment2 'Test passed'
END
REMOVEntw
The REMOVEntw command can be used to remove a network (ntw) topology.
REMOVEntw syntax
REMOVEntw
END
REMOVEntw example
REMOVE ntw
userLabel 'ntw1'
END
REMOVEsbn
The REMOVEsbn command can be used to remove a subnetwork (sbn) topology.
REMOVEsbn syntax
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
REMOVEsbn
END
REMOVEsbn example
REMOVE sbn
userLabel 'sbn1'
END
REMOVEet
The REMOVEet command can be used to remove an elementary topology (et).
REMOVEet syntax
REMOVEet
END
REMOVEet example
REMOVE et
userLabel 'et1'
END
REMOVEnode
The REMOVEet command can be used to remove a node topology.
REMOVEnode syntax
REMOVEnode
END
REMOVEnode example
REMOVE node
userLabel 'node1'
END
REMOVEphysicalConnection
The REMOVEphysicalConnection command can be used to remove a physical
connnection.
REMOVEphysicalConnection syntax
REMOVEphysicalConnection
END
REMOVEphysicalConnection example
REMOVE physicalConnection
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
END
....................................................................................................................................................................................................................................
March 2011
Topology Management Topology Management: IMPL, DEIMPL, and UPDATE
....................................................................................................................................................................................................................................
Topology Management: IMPL, DEIMPL, and UPDATE

Available commands for the IMPL, DEIMPL, and UPDATE of topology management
The following verbs and objects are available for the implementation (IMPL),
deimplementation (DEIMPL), and update (UPDATE) of topology management:
• “IMPL” (p. 10-9)
• “DEIMPL” (p. 10-10)
• “UPDATE et” (p. 10-10)
IMPL
The IMPL command is used to implement particular topology, which can be a network
(ntw), a subnetwork (sbn), and elementary topology (et), or a physical connection
(physicalCONNECTION.).
IMPL syntax
IMPL <ntw |sbn | et | physicalConnection>

END
IMPL ntw example
The IMPL ntw command is used to implement a network (ntw).
IMPL ntw
userLabel 'ntw1'
END
IMPL sbn example
The IMPL sbn command is used to implement a subnetwork (sbn).
IMPL sbn
userLabel 'sbn1'
END
IMPL et example
The IMPL et command is used to implement an elementary topology (et).
IMPL et
userLabel 'et1'
END
IMPL physicalConnection example
The IMPL physicalConnection command is used to implement a physical connection.
IMPL physicalConnection
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
DEIMPL
The DEIMPL command is used to deimplement particular topology, which can be a
network (ntw), a subnetwork (sbn), and elementary topology (et), or a physical
connection (physicalCONNECTION.).
DEIMPL syntax
DEIMPL <ntw |sbn | et | physicalConnection>

END
DIMPL ntw example
The DIMPL ntw command is used to deimplement a network (ntw).
DIMPL ntw
userLabel 'ntw1'
END
DIMPL sbn example
The DIMPL sbn command is used to deimplement a subnetwork (sbn).
DIMPL sbn
userLabel 'sbn1'
END
DIMPL et example
The DIMPL et command is used to deimplement an elementary topology (et).
DIMPL et
userLabel 'et1'
END
DIMPL physicalConnection example
The DIMPL physicalConnection command is used to deimplement a physical connection.
DIMPL physicalConnection
END
UPDATE et
The UPDATE et command is used to update the globalCfg attribute et (elementary
topology).
UPDATE et syntax
UPDATE et
globalCfg <True | False>
END
UPDATE et example
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
The UPDATE et command is used to update the globalCfg attribute et (elementary
topology).
UPDATE et
userLabel 'STM1'
globalCfg True
END
....................................................................................................................................................................................................................................
March 2011
Topology Management Topology Management: SPLIT, JOIN, and OBJECT
....................................................................................................................................................................................................................................
Topology Management: SPLIT, JOIN, and OBJECT

Available commands for SPLIT, JOIN, and OBJECT topology
The following verbs and objects are available for SPLIT, JOIN, and OBJECT topology
management:
• “SPLITphysicalConnection” (p. 10-12)
• “JOINphysicalConnection” (p. 10-13)
• “OBJECTconnection” (p. 10-13)
Certain syntaxes are used for 4-fiber physical connections. These syntaxes are clearly
marked in the examples in this section.
SPLITphysicalConnection
SPLIT is used to split a defined physical connection.
SPLITphysicalConnection syntax
reqType <splitType>
userLabelPhyConnToSplit <user_label>
userLabelFirstPhyConn <user_label>
userLabelOldFirstPort <user_label>
userLabelNewFirstPort <user_label>
userLabelSecondPhyConn <user_label>
userLabelOldSecondPort <user_label>
userLabelNewSecondPort <user_label>
<split_phyConn_attr>
END
SPLITphysical connection (undoSplit) example
reqType undoSplit
userLabelPhyConnToSplit 'Phy_Conn_Split'
userLabelFirstPhyConn 'Phy_Conn_1'
userLabelOldFirstPort 'Old_Port_1'
userLabelNewFirstPort 'New_Port_1'
userLabelSecondPhyConn 'Phy_Conn_2'
userLabelOldSecondPort 'Old_Port_2'
userLabelNewSecondPort 'New_Port_2'
END
SPLITphysical connection (split) example
The following syntax is only used in a 4-fiber physical connection
reqType split
userLabelPhyConnToSplit 'Phy_Conn_Split'
userLabelOldFirstPort 'Old_Port_1'
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
userLabelNewFirstPort 'New_Port_1'
userLabelOldSecondPort 'Old_Port_2'
userLabelNewSecondPort 'New_Port_2'
userLabelPhyConnToSplit4f 'Phy_Conn_Split_4f'
userLabelFirstPhyConn4f 'Phy_Conn_1_4f'
userLabelOldFirstPort4f 'Old_Port_1_4f'
userLabelNewFirstPort4f 'New_Port_1_4f'
userLabelSecondPhyConn4f 'Phy_Conn_2_4f'
userLabelOldSecondPort4f 'Old_Port_2_4f'
userLabelNewSecondPort4f 'New_Port_2_4f'
END
JOINphysicalConnection
JOIN is used to join two physical connections.
JOINphysicalConnection syntax
reqType <joinType>
userLabelFirstPhyConn <user_label>
userLabelSecondPhyConn <user_label>
userLabelNewPhyConn <user_label>
<join_phyConn_attr>
END
JOINphysical connection (undoJoin) example
reqType undoJoin
userLabelNewPhyConn 'New_Phy_Conn'
END
JOINphysicalConnection (join) example
The following syntax is only used in a 4-fiber physical connection.
reqType join
userLabelNewPhyConn 'New_Phy_Conn'
userLabelFirstPhyConn4f 'Phy_Conn_14f'
userLabelSecondPhyConn4f 'Phy_Conn_24f'
userLabelNewPhyConn4f 'New_Phy_Conn4f'
END
OBJECTconnection
OBJECT is used to connect and/or disconnect one or more physical connections.
OBJECTconnection syntax
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
OBJECTconnection
actionType <actionConnection>
connectMode <modeConnection>
{ physicalConnection <user_label> } ...
END
OBJECTconnection example
OBJECTconnection
actionType connect
connectMode immediate
physicalConnection 'Phy_Conn_To_Connect'
....................................................................................................................................................................................................................................
March 2011
11 NAP Management
11
Overview
Purpose
pertains to the CLI commands for management of a network access points (NAP).
Contents
NAP Management Overview 11-2

NAP Management: UPLOADnap 11-3
NAP Management: REMOVEnap 11-4
...................................................................................................................................................................................................................................
March 2011
NAP Management NAP Management Overview
....................................................................................................................................................................................................................................
NAP Management Overview

Available commands for nap
The following verbs and objects are available for the upload or removal of a network
access point (NAP) on defined topologies such as a network (ntw), subnetwork (sbn), an
elementary topology (et), or a node.
• “UPLOADnap” (p. 11-3)
• “REMOVEnap” (p. 11-4)
....................................................................................................................................................................................................................................
March 2011
NAP Management NAP Management: UPLOADnap
....................................................................................................................................................................................................................................
NAP Management: UPLOADnap

UPLOADnap
The UPLOADnap is used to upload the network access points (NAPs) that are defined for
a particular topology level.
UPLOADnap syntax
UPLOADnap <ntw | sbn | et | node>

END
UPLOADnap ntw example
UPLOADnap ntw
userLabel 'ntw1'
END
UPLOADnap sbn example
UPLOADnap sbn
userLabel 'sbn1'
END
UPLOADnap et example
UPLOADnap et
userLabel 'et1'
END
UPLOADnap node example
UPLOADnap node
userLabel 'node1'
END
....................................................................................................................................................................................................................................
March 2011
NAP Management NAP Management: REMOVEnap
....................................................................................................................................................................................................................................
NAP Management: REMOVEnap

REMOVEnap
The REMOVEnap is used to remove all network access points (NAPs) that are defined for
a particular topology level or to remove a single NAP that is defined with a portname.
REMOVEnap syntax for a particular topology
REMOVEnap <ntw | sbn | et | node>

END
REMOVEnap syntax for a single NAP
REMOVEnap <nap>>
portName <string>>
END
REMOVEnap ntw example
REMOVEnap c
userLabel 'ntw1'
END
REMOVEnap sbn example
REMOVEnap sbn
userLabel 'sbn1'
END
REMOVEnap et example
REMOVEnap et
userLabel 'et1'
END
REMOVEnap node example
REMOVEnap node
userLabel 'node1'
END
....................................................................................................................................................................................................................................
March 2011
12 rmBatchUtil Tool
12
Overview
Purpose
pertains to the rmBatchUtil tool.
Contents
rmBatchUtil Tool Overview 12-2
...................................................................................................................................................................................................................................
March 2011
rmBatchUtil Tool rmBatchUtil Tool Overview
....................................................................................................................................................................................................................................
rmBatchUtil Tool Overview

Description
To build a database, the user must execute the following command:
$ cd /usr/Systems/RM_<nms_instance>/bin
$ rmBatchUtil [-ntw <number>] [-syntax] [-file <filename> | -f-]
[-stop] [-nochkconstr] [-nobuffering]
Where:
ntw is used to specify the network Domain Identifier.
syntax is used to check the syntax of the commands.
file is used to specify the filename of the command file.
f- is used to indicate that the commands must be inserted from the standard input.
stop is used to indicate that rmBatchUtil must stop when an error occurs.
nochkconstr is specified to disable checks for CTPs that appear in CONSTRpath and
CONSTRtrail commands
nobuffering is specified to disable command buffering. The default is to have buffering
enabled.
Syntax errors
The tool stops when a syntactical error on a keyword occurs.
The following message is displayed on standard output:
line no <number> token = <keyword>
If an error occurs on an attribute value, the following message is displayed:
line no <number>-Value <string_value> not found in the NML d.b.
The command is skipped and the tool continues to execute the next command, unless the
utility is running with -stop option on.
For special commands (such as SET, SET path, and SET trail), the tools stops
immediately.
Executing errors
In an error occurs during tool execution, the behavior of the tool depends on whether
-stop option has been specified and the type of the error that has occurred. If a normal
error occurs, the tool stops the execution of the command, only if is running with -stop
option; otherwise the command is skipped and the execution continues with the next
command. The tool stops immediately when an internal application error occurs.
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
Error handling example 1
In example 1, the SET, CREATE path, and DELETE path are executed. The tool runs
without the -stop option; and during execution, a syntactical error on an attribute value
occurs. The CREATE path command is skipped, and the next command, which is
DELETE path, is executed.
SET ntwId 1 END

CREATEpath
userLabel "1Gb Rate Adapt II"
pathRate eth1GbRateAdapt
allocRule user
userId "lts4182/snml"
pmAutomatic false
msProtProfile normal
pdhAlrEnabRule onImplementation
sdhAlrEnabRule onImplementation
transportRate au4virtN
serviceType Ethernet
!line: 21 - Value Ethernet not found in the NML d.b.
concatenationLevel 2
endTpList
node "Virtual Fox I"
portName "1Gb I"
node "Virtual Fox II"
portName "1Gb II"
END
END
!Error creating path
DELETEpath
userLabel "1Gb Rate Adapt I"
END
!userLabel: 1Gb Rate Adapt I - path deletion executed
!===================================================
! Commands fetched: 3 - Commands executed with errors: 1 - Warnings
0
! ===================================================

In example 2, a syntactical error on an attribute value occurs and the utility runs with the
-stop option. The tool stops immediately.
SET ntwId 1 END

CREATE path
userLabel "1Gb Rate Adapt I"
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
pathRate eth1GbRateAdapt
allocRule user
userId "lts4182/snml"
pmAutomatic false
pdhAlrEnabRule onImplementation
sdhAlrEnabRule onImplementation
transportRate au4virtN
serviceType Ethernet
!line: 21 - Value Ethernet not found in the NML d.b. !
!--- ERROR --- SHUTTING DOWN !========================

In example 3, the SET, CREATE physicalConn, and SET timeout are executed.
During the execution of the second command, an error occurs. Because the utility is
running without the -stop option, the next command, which is SET timeout, is executed.
SET ntwId 1 END

CREATE physicalConn
userLabel"Phy Conn Test I Virtual/Virtual"
userId "snml@tlvhiz"
aVirtualNode "VirtualPo I"
portName "VirtualPo I/Port I"
portTechno sdh portType stm16
zVirtualNode "VirtualPo II"
portName "VirtualPo II/Port I"
portTechno sdh portType stm16 END
!RECEIVED CREATE CONFIRMATION FOR Phy Conn Test I Virtual/Virtual
!checkResponseCode:
!Error : The creation of a port belonging to a virtual NE failed:
!please check that the related userLabel is unique.
SET timeout 20 END
!=========================================================
! Commands fetched: 3 - Commands executed with errors: 1 - Warnings
0 !
!=========================================================
....................................................................................................................................................................................................................................
March 2011
13 CLI Commands
13
Overview
Purpose
This chapter provides reference material and examples that pertain to the commands that
are used in the Command Language Interface (CLI).
Contents
Command Table 13-2

Reroute Path or Trail (REROUTE path/trail) 13-4
Undo Route Path or Trail (UNDOROUTE path/trail) 13-6
UPDSNC Path, Trail, or SNC (UPDSNC path/trail/snc) 13-7
Configure Link NPA (CONFIGURELINKnpa) 13-9
Move Objects (MOVEObjects) 13-11
Move Port (MOVEport) 13-13
Create Path (CREATEpath) 13-15
Multiset Node (MULTSETnode) 13-17
Manage Switch (manageSwitch) 13-19
Add Ends Path (ADDENDSpath) 13-21
Remove Ends Path (REMOVEENDSpath) 13-23
Connect Trail (CONNECTtrail) 13-25
Disconnect Trail (DISCONNECTtrail) 13-27
Update Class (UPDATE CLASS) 13-29
Update ET / Update Node (Update et/Update node) 13-30
Remove NPA (REMOVEnpa) 13-31
Add NPA (ADDnpa) 13-32
Add Leg to Path (ADDLEGtoPath) 13-34
Remove Leg from Path (REMOVELEGfromPath) 13-36
Remove Leg Keep NAP in Path (REMOVELEGkeepNapInPath) 13-38
...................................................................................................................................................................................................................................
March 2011
CLI Commands Command Table
....................................................................................................................................................................................................................................
Command Table
Commands
Class Related Link

PATH “Reroute Path or Trail (REROUTE path/trail)” (p. 13-4)
“Undo Route Path or Trail (UNDOROUTE path/trail)” (p. 13-6)
“UPDSNC Path, Trail, or SNC (UPDSNC path/trail/snc)” (p. 13-7)
“Create Path (CREATEpath)” (p. 13-15)
“Manage Switch (manageSwitch)” (p. 13-19)
“Add Ends Path (ADDENDSpath)” (p. 13-21)
“Remove Ends Path (REMOVEENDSpath)” (p. 13-23)
ACT_UPDATE CLASS
“Add Leg to Path (ADDLEGtoPath)” (p. 13-34)
“Remove Leg from Path (REMOVELEGfromPath)” (p. 13-36)
“Remove Leg Keep NAP in Path (REMOVELEGkeepNapInPath)”
(p. 13-38)
TRAIL “Reroute Path or Trail (REROUTE path/trail)” (p. 13-4)
“UPDSNC Path, Trail, or SNC (UPDSNC path/trail/snc)”
(p. 13-7)UPDSNC PATH/TRAIL/SNC
“Manage Switch (manageSwitch)” (p. 13-19)
“Connect Trail (CONNECTtrail)” (p. 13-25)
“Disconnect Trail (DISCONNECTtrail)” (p. 13-27)
ACT_UPDATE CLASS
“Undo Route Path or Trail (UNDOROUTE path/trail)” (p. 13-6)
NODE “Move Objects (MOVEObjects)” (p. 13-11)
“Multiset Node (MULTSETnode)” (p. 13-17)
“Update ET / Update Node (Update et/Update node)” (p. 13-30)
PORT “Move Objects (MOVEObjects)” (p. 13-11)
“Move Port (MOVEport)” (p. 13-13)
NPA “Configure Link NPA (CONFIGURELINKnpa)” (p. 13-9)
“Remove NPA (REMOVEnpa)” (p. 13-31)
“Add NPA (ADDnpa)” (p. 13-32)
SNC “UPDSNC Path, Trail, or SNC (UPDSNC path/trail/snc)” (p. 13-7)
NAP ACT_UPDATE CLASS
ET “Update ET / Update Node (Update et/Update node)” (p. 13-30)
PHYSICALCONN “Update Class (UPDATE CLASS)” (p. 13-29)
ACT_UPDATE CLASS
....................................................................................................................................................................................................................................
March 2011
CLI Commands Command Table
....................................................................................................................................................................................................................................
Class Related Link

TCAPROFILE “Update Class (UPDATE CLASS)” (p. 13-29)
PMEASURE “Update Class (UPDATE CLASS)” (p. 13-29)
PMCOUNTREP “Update Class (UPDATE CLASS)” (p. 13-29)
TCRPROFILE “Update Class (UPDATE CLASS)” (p. 13-29)
ASAPROFILE “Update Class (UPDATE CLASS)” (p. 13-29)
RESTRULE “Update Class (UPDATE CLASS)” (p. 13-29)
....................................................................................................................................................................................................................................
March 2011
CLI Commands Reroute Path or Trail (REROUTE path/trail)
....................................................................................................................................................................................................................................
Reroute Path or Trail (REROUTE path/trail)

Synopsis
REROUTE path | trail

userLabel "userLabel"
trafficImpactsAllowed | trafficImpactsNotAllowed
automaticImplementation | onlyAllocation
endTpList
<tpA>
<tpZ>
END
END
Functionality
Action: NLACreroute
ActInfo: SG_RerouteInfo
ActReply: SG_RerouteReply
This action is invoked on a class path or a trail. Before calling the action request, a get
object instance of the trail or path that is associated with userLabel must be specified in
the command, which is done with a get from the application database.
The structure for SG_RerouteInfo is the following:
• SG_RerouteInfo_Operation
• a pointer to SG_RerouteInfo_mode
• two fields of type SG_ObjectInstance
The field operation is filled with three possible values:
• rerouteOnlyAllocation
• rerouting
• undorerouting
The undorouting value is specified in the UNDOREROUTE path/trail command.
The field mode is optional and is forced only if the user writes in the command
trafficImpactsAllowed token; otherwise, it is normal. The optional two fields of type
SG_ObjectInstance contain the tpA and tpZ that are written in TpList, when they are
specified. The TpList contains Cap and/or Ctp for the trail, and Ctp and/or Nap for the
path.
The type ActReply is the same as that of the SG_GenMultReply structure, which is used
for a response of a GenMultReply action.
The response for this command is managed as a response from a GenMultReply response
would be managed; nothing of consequence is done for this command.
Examples
....................................................................................................................................................................................................................................
March 2011
CLI Commands Reroute Path or Trail (REROUTE path/trail)
....................................................................................................................................................................................................................................
REROUTEpath
userLabel "pathPippo"
trafficImpactsAllowed
automaticImplementation
endTpList
END
END
REROUTEpath
trafficImpactsAllowed
onlyAllocation
endTpList
nap "nap1"
ctp "1660_5/stm16/prtE" payloadPos "02"
END
END
REROUTEtrail
userLabel "trailPippo"
trafficImpactsNotAllowed
endTpList
ctp "1660_5/stm16/prtE" payloadPos "02"
cap "1660_5/stm16/prtA" payloadPos "01"
END
END
REROUTEtrail
trafficImpactsNotAllowed
endTpList
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Undo Route Path or Trail (UNDOROUTE path/trail)
....................................................................................................................................................................................................................................
Undo Route Path or Trail (UNDOROUTE path/trail)

Synopsis
UNDOREROUTE path | trail

endTpList
<tpA>
<tpZ>
END
END
Functionality
Action: NLACreroute
ActInfo: SG_RerouteInfo
ActReply: SG_RerouteReply
The functionality of this command is the same as that of the REROUTEpath/trail
command; however, the value of the Operation and Mode fields differ:
• The Operation field always has the value of undorerouting.
• The Mode field always has the value of NULL.
Examples
UNDOREROUTE path
endTpList
END
END
UNDOREROUTE path
endTpList
node "NE_V5" usedDir bidirectional
END
END
UNDOREROUTE trail
endTpList
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands UPDSNC Path, Trail, or SNC (UPDSNC path/trail/snc)
....................................................................................................................................................................................................................................
UPDSNC Path, Trail, or SNC (UPDSNC path/trail/snc)

Synopsis

propagateToSnc | dontPropagateToSnc
updList
attrName_2 attrVa1_2
attrName_n attrVal_n
END
END
Functionality
Action: NLACupdSncAttrs
ActInfo: SG_UpdSncAttrsInfo
ActReply: SG_UpdSncAttrsReply
This action is invoked on class path or trail. A get object instance of a trail/path is
associated with the userLabel that is specified in the command. It is needed before calling
the action request with a get from the application database.
The pointer composes the structure SG_UpdSncAttrsInfo to SG_UpdSncAttrsInfo_propa-
gateToSnc and SG_GenSetInfo. It contains the attributes and their values that are
specified in updList.
The field SG_UpdSncAttrsInfo_propagateToSnc can assume the following values,
according to the token that is specified in the command. It is NULL only for the
UPDSNCsnc command.
• dontPropagate
• Propagate
The type ActReply is the same as the SG_GenMultReply structure that is used for the
response of GenMultReply action.
The response for this command is managed similarly to a GenMultReply response;
nothing of consequence is done for this command.
Examples
UPDSNC trail
propagateToSnc
updList
defaultPriority2
defaultReroutingnoRestoration
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands UPDSNC Path, Trail, or SNC (UPDSNC path/trail/snc)
....................................................................................................................................................................................................................................
END
UPDSNC snc
userLabel "snc Pippo"
updList
priority 3
END
END
UPDSNC path
userLabel "path Pippo"
dontPropagateToSnc
updList
defaultPriority4
userLabel "new UserLabel"
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Configure Link NPA (CONFIGURELINKnpa)
....................................................................................................................................................................................................................................
Configure Link NPA (CONFIGURELINKnpa)

Synopsis
CONFIGURETELINKnpa
userLabel "npa-userLabel"
opType create |
update userLabel "teLink-userLabel" |
move userLabel "teLink-userLabel" |
remove userLabel "teLink-userLabel" |
linkMetric 20
srgList
userLabel "srg-1"
userLabel "srg-2"
............
userLabel "srg-n"
END
linkList
userLabel "conn-1"
userLabel "conn-2"
............
userLabel "conn-n"
END
END
Functionality
Action: NLACteLinkConfigure
ActInfo: SG_TeLinkConfigureInfo
ActReply: SG_TeLinkConfigureReply
This action is invoked on the class npa.
The following two structures create the structure SG_TeLinkConfigureInfo:
• The SG_GenOperType structure contains the NULL for the operation create;
otherwise, the object instance of teLink is updated, moved, or removed. For a create,
linkList is mandatory, while srgList and linkMetric are optional. For an update,
srgList and linkMetric are optional. A move is mandatory for linkList.
• The SG_GenSetInfo structure is filled with attributes that are specified in the
command. For the srgList and linkList attributes, the relative values are of the type
SG_ObjectList and they contain the ObjectInstance of Srg or the Link that is
specified.
The type ActReply is the same SG_MultReplyWithInstance structure and is like a
GenMultReply response; nothing of consequence is done for this command.
Examples
CONFIGURETELINKnpa
userLabel "npaUserLabel"
....................................................................................................................................................................................................................................
March 2011
CLI Commands Configure Link NPA (CONFIGURELINKnpa)
....................................................................................................................................................................................................................................
opType create
linkMetric 30
srgList
userLabel "srg 1"
END
linkList
userLabel "conn 1"
userLabel "conn 2"
END
END
CONFIGURETELINKnpa
opType update
userLabel "TeLink1"
END
CONFIGURETELINKnpa
opType update
userLabel "TeLink1"
linkMetric 20
END
CONFIGURETELINKnpa
opType move
userLabel "TeLink1"
linkList
userLabel "conn 1"
userLabel "conn 2"
userLabel "conn 3"
END
END
CONFIGURETELINKnpa
opType remove
userLabel "TeLink1"
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Move Objects (MOVEObjects)
....................................................................................................................................................................................................................................
Move Objects (MOVEObjects)

Synopsis
MOVEObjects {node | port}

newParentLabel {sbn1stLev | sbn2ndLev | node} "topolLabel"
movingObjList
userLabel "movingLabel_1"
userLabel "movingLabel_2"
........
........
userLabel "movingLabel_n"
END
Functionality
Action: NLACmoveObjects
ActInfo: SG_MoveObjectsInfo
ActReply: SG_MoveObjectsReply
This action is always invoked on a class network. The parent topology includes the
following:
• To move ports, the parent topology is always the node.
• To move nodes, the parent topology can be a subnetwork (sbn1stLev) or an
elementary topology (et) (sbn2ndLev).
The structure SG_MoveObjectsInfo consists of a buffer of the type SG_MoveObjInfo.
This structure can to be viewed as a sequence of three fields:
• objClass, which represents the class node or the port
• The object instance of new parent object
• The object instance of object that is to be moved
All object instances mentioned come from their userLabel, which is specified in the
command. These three values are the same objClass and object instance of the new parent
object. An object can compose the movingObjList.
The type ActReply is the same SG_GenMultReply structure that is used for the response
of a GenMultReply.
The response for this command is managed similarly as a GenMultReply response would
be managed; nothing of consequence is done for this command.
Examples
MOVEObjects node
newParentLabel sub2ndLev "EtTopolLabel"
movingObjList
userLabel "nodeLabel_1"
userLabel "nodeLabel_2"
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Move Objects (MOVEObjects)
....................................................................................................................................................................................................................................
END
MOVEObjects node
newParentLabel sub1stLev "SbnTopolLabel"
movingObjList
userLabel "nodeLabel"
END
END
MOVEObjects port
newParentLabel node "NewTopolLabel"
movingObjList
userLabel "portLabel_1"
END
END
The nobuffering parameter

The nobuffering parameter is used to disable buffering. If buffering is disabled, the Mng
agent performs every GET_REQUEST; otherwise, the objects are taken from the buffer if
they are present. The default is to enable buffering.
Example:
rmBatchUtil -nobuffering -file path.pdl
....................................................................................................................................................................................................................................
March 2011
CLI Commands Move Port (MOVEport)
....................................................................................................................................................................................................................................
Move Port (MOVEport)

Synopsis
MOVEport
sourceNode "userLabel del nodo sorgente"
destNode "userLabel del nodo destinazione"
userLabel "user label della porta 1"
destUserLabel "nuova user label della porta 1" {toBeCreated}
.....................................................
.....................................................
.....................................................
userLabel "user label della porta n"
destUserLabel "nuova user label della porta n" {toBeCreated}
END
Functionality
Action: NLACtransferObjs
ActInfo: SG_TransferObjsInfo
ActReply: SG_TransferObjsReply
This action is always invoked on a class network with a relative object instance. The
fields that are listed in Synposis are mandatory, except for the token toBeCreated. The
structure to fill is SG_TransferObjsInfo.
The field checkOnly is a Boolean expression and its value is always TRUE. The agent
does not consider this field.
From the value sourceNode that is specified in the command, the object instance of the
parent and its virtual or real element is known. This value fills the field sourceParentObj
in the structure and sends it to the functional agent; the same applies for destParentObj.
From the element type of the source parent and destination parent, the following two
topologies are considered for MOVEport:
• virtual
• real
Both the rmBatchUtil and Csa functional agents do not currently manage moving a port
from a real element to virtual element or vice versa. This information is used to fill the
transferObject structure, which consists of a buffer of type SG_TransferInfo and a field
fromObjInstance that contains the RDN of the source port.
The compilation of the structure SG_ToObjInfo depends on the type of move that is to be
made. The moves can be one of the following:
• Virtual-to-Virtual move
....................................................................................................................................................................................................................................
March 2011
CLI Commands Move Port (MOVEport)
....................................................................................................................................................................................................................................
The field toObjInfo can be NULL for a port that was once moved. It maintains the
same name; otherwise, the field objUpdLabel is validated if an existing port should be
overwritten. (The token toBeCreated in the rmBatch command must be specified.)
Any instance in which the virtual port is renamed once it is moved is not supported.
• Real-to-Real move
The field toObjInfo is validated with objCreLabel if a new port is created as a planned
port. (The token toBeCreated into rmBatch command must be specified.) Otherwise,
the field objInstance is validated, if an existing port (which is put in RDN) is to be
overwritten.
The type ActReply is SG_GenericReply, which is used for the response of new
GenMultReply action. The callback for this command only prints the messages sent from
the action.
Examples
In the following example, only NewPort1 is created as new.
MOVEport
sourceNode "NodoSorgente"
destNode "DestNodo"
userLabel "porta1"
destUserLabel "NewPorta1" toBeCreated
userLabel " porta2"
destUserLabel "Porta2"
END
In the following example, all ports are created as new.
MOVEport
destNode "DestNodo"
userLabel "porta1"
userLabel " porta2"
userLabel " porta3"
END
In the following example, none of the ports are created as new.
MOVEport
destNode "DestNodo"
userLabel "porta1"
userLabel " porta2"
userLabel " porta3"
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Create Path (CREATEpath)
....................................................................................................................................................................................................................................
Create Path (CREATEpath)

Synopsis
CREATEpath
Attribute_1 "value_attr_1"
..................................
endTpList
{nap | node | port}
AttributeTp1_1 "value_attrTp1_1"
..................................
AttributeTp1_n "value_attrTp1_n"
{nap | node | port}
..................................
{nap | node | port}
..................................
{nap | node | port}
..................................
END
END
Functionality
Action: It is a create request to a TRS agent.
ActReply: handle_creation_response
This create request is the same as the previous version of rmBatchUtil, except TpList can
now contain every attribute that belongs to class Nap, Node, or Port that a section for
TpList in the command specifies. The attribute list, which is sent to TRS agent, contains
the particular attribute NLAnapList. This attribute value is stored in the structure
TranspEndList. The attributes that are relative to TpList are specified in the command
create. In the previous version of rmBatchUtil, the attribute is the same, but the structure
is SG_NapList. The response of creation is the same as that of the previous version of
rmBatchUtil.
Examples
CREATEpath
....................................................................................................................................................................................................................................
March 2011
CLI Commands Create Path (CREATEpath)
....................................................................................................................................................................................................................................
userLabel "path in npa"
serviceType pdh
pathRate ho140Mb
transportRate hoAu4
configurationRate notMeaningful
userId "dba/snml"
pmAutomatic false
pdhAlrEnabRule onCommissioning
sdhAlrEnabRule onCommissioning
concLevelMode notMeaningful
concatenationLevel 0
maxSuppConcLevel 0
ethMapping notMeaningful
npaMainSpareFactor 100
msspringDCFactor 80
lcasControl notAvailable
srvTrailsRouting notMeaningful
sncpType sncpIpreferredAlr
defaultRerouting noRestoration
defaultPriority 4
defaultReversionMode manual
endTpList
nap "1660--95/r01s1b01p02c01" usedDir bidirectional
nap "1660--90/r01s1b01p03c01" usedDir bidirectional
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Multiset Node (MULTSETnode)
....................................................................................................................................................................................................................................
Multiset Node (MULTSETnode)

Synopsis
MULTSETnode
userLabel "node-label"
<routingDomain-automatic>
<routingDomain-listOfPort>
<routingDomain-state>
END
Where:
<routingDomain-automatic> = ROUTING_DOMAIN_AUTOMATIC
<routingDomain-listOfPort> = routingDomainName "label" | <null-domain> |
ALL_PORT | <port-list>
<port-list> = port-list <portElem> [<portElem>] END
<portElem> = userLabel "label"
<null-domain> = NULL
<routingDomain-state> = routingDomainState <rouDom-state>
<rouDom-state> = disabled | enabledForPartitioning | enabledForMigration
Functionality
Action: NLACmultSetAttributes
ActInfo: SG_MultSetAttributesInfo
ActReply: SG_MultSetAttributesReply
This action is always invoked on a class node that contains the port that changes the
routing Domain Name or the routing Domain State. This action is invoked on the object
instance of the class node that is specified in the command. This command changes the
routing domain name or the routing domain state for all ports or for a list of ports that is
included in a specified node. A null routing domain name can be specified to unset the
previous value (see examples section).
The command specifies the routing domain state that assumes one of these values:
• disabled
• enabledForPartitioning
• enabledForMigration
The ActInfo is filled in this manner: the field attrList contains the attribute
NLAroutingDomainName, NLAroutingDomainId, or NLAroutingDomainState and its
value. If the token ROUTING_DOMAIN_AUTOMATIC is used, the NLAroutingDo-
mainId must be set to -1 in the attrList field. The field setScope, the union of
baseObjectOnly and scope, is baseObjectOnly (type SGL_NULL) only if
routingDomainState is set on the node.
....................................................................................................................................................................................................................................
March 2011
CLI Commands Multiset Node (MULTSETnode)
....................................................................................................................................................................................................................................
If routing is not set on the node, the field setScope is the structure scope. The field
filteredObjClass contains the oid of the class port, and the structure filteredObjList is
contained in all ports objectInstance that are specified in the list port in the command.
The type ActReply is SG_ExtendedReply, which is used for the response of the new
GenMultReply action. The callback for this command only prints the messages sent from
the agent CSA.
Examples
MULTSETnode userLabel "1660SM_2"

routingDomainName " routDomName "
ALL_PORT
END

routingDomainName NULL
ALL_PORT
END

routingDomainName NULL
portList
userLabel "1660SM_2/r01s1b01p13c01"
END
END

routingDomainName "routDomName"
portList
END
END

routingDomainState disable
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Manage Switch (manageSwitch)
....................................................................................................................................................................................................................................
Manage Switch (manageSwitch)

Synopsis
manageSwitch {path | trail}

operationMode {revertive | nonRevertive}
END
END
as an alternative:
manageSwitch {path | trail}

command { release | lockout | forceMain | forceSpare | manualMain
| manualSpare }
END
END
Functionality
Action: NLACmanageSwitch
ActInfo: SG_ManageSwitchInfo
ActReply: SG_ManageSwitchReply
This action is always invoked on a class connection in a topology for every cointo that is
associated with the path or trail that the userLabel token specifies in the command and
filters with connectionType equal to bridgeAndSwitch, switch, or dropAndCont.
The ActInfo is enumerated to SG_SNCPPendSwitchCmd, which is to be set to the
setRevertive or setNoRevertive value by the token operationMode that is specified in the
command. The callback associated with this action is genericExtendReply, which does
not manage anything of consequence.
As an alternative to the operationmode parameter, the parameter command can be used.
The possible values of the parameter command are: release | lockout | forceMain |
forceSpare | manualMain | manualSpare
Examples
manageSwitch path
userLabel " pathPippo "
operationMode revertive
END
manageSwitch path
userLabel " pathPippo "
operationMode nonRevertive
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Manage Switch (manageSwitch)
....................................................................................................................................................................................................................................
manageSwitch trail
userLabel " trailPippo "
operationMode revertive
END
manageSwitch trail
userLabel " trailPippo "
operationMode nonRevertive
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Add Ends Path (ADDENDSpath)
....................................................................................................................................................................................................................................
Add Ends Path (ADDENDSpath)

Synopsis
ADDENDSpath
allocRule {user | automatic}
implRule {user | automatic}
checkSwitches {true | false}
endTpList
{nap | node | port}
.................................
{nap | node | port}
................................
{nap | node | port}
.................................
.................................
{nap | node | port}
AttributeTp_m_1 "value_attrTp_m_1"
..................................
AttributeTp_m_n "value_attrTp_m_n
END
END
Functionality
Action: NLACmanageEnds
ActInfo: SG_ManageEndsInfo
ActReply: SG_ManageEndsReply
This action is invoked to add ends to a path that the userLabel token specifies in the
command. The ActInfo is a structure SG_ManageEndsInfo that is filled with the
following:
• The operation that the operation token is to perform. (In this case, the value is
ManageEndsInfo_operation_removeEnd.).
• The type of allocation and implementation rules that can be used or are automatically
set by the allocRule and impl- Rule tokens.
• The checkSwitches value, which can be 0 or 1, that the checkSwitches token
specifies.
....................................................................................................................................................................................................................................
March 2011
CLI Commands Add Ends Path (ADDENDSpath)
....................................................................................................................................................................................................................................
All of these tokens can be specified in the command. Only the path userLabel is
mandatory. The field endlist is filled with a TpList that is specified in the command and
its attributes. The callback associated with this action is genericExtendReply, which does
not manage anything of consequence.
Examples
ADDENDSpath
userLabel "10/100 virt. conc."
allocRule automatic
implRule user
checkSwitches true
endTpList
nap "1660ver4.1/r01s1b26p06-gMAU"
END
END
ADDENDSpath
allocRule user
endTpList
endType endA
END
END
ADDENDSpath
userLabel "MANAGE ENDS"
allocRule user
implRule user
endTpList
port "1650SMC_1/r01s1b09p02"
endType endZ
portName "PORTA GENOVA - 2!!!"
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Remove Ends Path (REMOVEENDSpath)
....................................................................................................................................................................................................................................
Remove Ends Path (REMOVEENDSpath)

Synopsis
REMOVEENDSpath
endTpList
{nap | node | port}
.....................................................
{nap | node | port}
.....................................................
{nap | node | port}
.....................................................
.....................................................
{nap | node | port}
.....................................................
END
END
Functionality
This action is invoked to remove ends from a path that the userLabel token specifies in
the command. The ActInfo is a structure, SG_ManageEndsInfo, that is filled with the
operation that the operation token is to perform. (In this case, the value is
ManageEndsInfo_operation_removeEnd.) All of these tokens can be specified in the
command. Only the path userLabel is mandatory. The field endlist is filled with a TpList
that is specified in the command and its attributes. The callback associated with this
action is genericExtendReply, which does not manage anything of consequence.
Examples
REMOVEENDSpath
endTpList
....................................................................................................................................................................................................................................
March 2011
CLI Commands Remove Ends Path (REMOVEENDSpath)
....................................................................................................................................................................................................................................
END
REMOVEENDSpath
endTpList
END
REMOVEENDSpath
userLabel "MANAGE ENDS"
endTpList
port "1650SMC_1/r01s1b09p02"
endType endZ
portName "PORTA GENOVA - 2!!!"
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Connect Trail (CONNECTtrail)
....................................................................................................................................................................................................................................
Connect Trail (CONNECTtrail)

Synopsis
CONNECTtrail
objectConnectMode {immediate|deferred}
endTpList
ctp "portName_1" payload "payloadPos_1"
END
END
Functionality
Action: NLACobjectConnection
ActInfo: SG_ObjectConnectionInfo
ActReply: SG_ObjectConnectionReply
This action is invoked to disconnect a trail that the userLabel token specifies in the
command. The ActInfo is a structure, SG_ObjectConnectionInfo, that is filled with the
action to be performed. (In this case, the value is SG_T_ObjectConnectionInfo_ac-
tionType_connect.) The Node and trailList fields in the ObjectConnectionInfo structure
are always set to NULL. The FromTp and toTp fields are filled with the object instance of
the ctp list that is specified in the command. The callback associated with this action is
genericExtendReply, which does not manage anything of consequence.
Examples
CONNECTtrail
userLabel "pathLCAS-VC12_2"
immediate
endTpList
ctp "Port_16" payloadPos "01/2/2.2"
ctp "port_16" payloadPos "01/2/2.2"
END
END
CONNECTtrail
userLabel "path_pippoTU3-VC3_1"
immediate
endTpList
ctp "port_16" payloadPos "02/2"
ctp "Port_16" payloadPos "02/2"
END
END
DISCONNECTtrail
userLabel "vim-vim VC4S24"
deferred
....................................................................................................................................................................................................................................
March 2011
CLI Commands Connect Trail (CONNECTtrail)
....................................................................................................................................................................................................................................
endTpList
ctp "1660_5/stm16/prtC" payloadPos "01"
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Disconnect Trail (DISCONNECTtrail)
....................................................................................................................................................................................................................................
Disconnect Trail (DISCONNECTtrail)

Synopsis
DISCONNECTtrail
endTpList
END
END
Functionality
Action: NLACobjectConnection
ActInfo: SG_ObjectConnectionInfo
ActReply: SG_ObjectConnectionReply
This action is invoked to disconnect a trail that the userLabel token specifies in the
command. The ActInfo is a structure, SG_ObjectConnectionInfo, that is filled with the
action to be performed. (In this case, the value is SG_T_ObjectConnectionInfo_ac-
tionType_disconnect.) The Node and trailList fields in the ObjectConnectionInfo
structure are always set to NULL. The FromTp and toTp fields are filled with the object
instance of the ctp list that is specified in the command. The callback associated with this
action is genericExtendReply, which does not manage anything of consequence.
Examples
DISCONNECTtrail
userLabel "pathLCAS-VC12_2"
endTpList
ctp "Port_16" payloadPos "01/2/2.2"
ctp "port_16" payloadPos "01/2/2.2"
END
END
DISCONNECTtrail
userLabel "path_pippoTU3-VC3_1"
endTpList
ctp "port_16" payloadPos "02/2"
ctp "Port_16" payloadPos "02/2"
END
END
DISCONNECTtrail
userLabel "vim-vim VC4S24"
endTpList
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Disconnect Trail (DISCONNECTtrail)
....................................................................................................................................................................................................................................
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Update Class (UPDATE CLASS)
....................................................................................................................................................................................................................................
Update Class (UPDATE CLASS)

Synopsis
UPDATE CLASS {physicalConn | tCAProfile | pMeasure | pmCountRep |

tCRProfile | aSAProfile | restRule }
attribute_1 value_1
attribute_2 value_2
attribute_n value_n
updList
attributeUpd_1 valueUpd_1
attributeUpd_2 valueUpd_2
attributeUpd_m valueUpd_m
END
END
Functionality
Action: Set Request
ActInfo: List of attributes to be modified (nlci_attribute_t *)
ActReply: updateAsapCallback
This Set Request is invoked for a class specified in synopsis—to update an attribute list
that belongs to a class. The call of the Set Request requires the attribute list to modify the
userLabel, through the userData field of the updated object. The callback associated is
updateAsapCallback. A message is printed only if an error occurs during update.
Examples
UPDATE CLASS physicalConn

userLabel "zc"
updList
userLabel "zc NEW"
allPathCost 10
END
END

userLabel "Meas1"
updList
pmMeasureActivity consistency
END
END
UPDATE CLASS aSAProfile

userLabel "Asap pippo"
updList
mediaFailure critical
degSignal critical
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Update ET / Update Node (Update et/Update node)
....................................................................................................................................................................................................................................
Update ET / Update Node (Update et/Update node)

Synopsis
Update et
{userLabel | fdnMapper} ²userLabel / fdnMapper²
globalCfg {true | false}
END
Update node
{userLabel | fdnMapper} ²userLabel / fdnMapper²
{seqNumInEt | nodeInEt} ²seqNumInEt / nodeInEt²
END
Functionality
Action: Set Request
ActInfo: Lst of attributes to be modified (nlci_attribute_t *)
ActReply: updateAsapCallback
This Set Request is invoked to update the attributes specified in command for a class or a
node. The callback associated is updObjectCallback. A message is printed only if an error
occurs during an update.
Examples
Update et
userLabel "et 1"
globalCfg false
END
Update et
userLabel "et 1"
globalCfg true
END
Update node
userLabel "node 1"
seqNumInEt "3"
END
Update node
userLabel "node 1"
nodeInEt "2"
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Remove NPA (REMOVEnpa)
....................................................................................................................................................................................................................................
Remove NPA (REMOVEnpa)

Synopsis
REMOVEnpa userLabel "userLabel"(optional)

npaType{genericRing|msSpring|msSpring4F|linearPlus|linear
Colon|ason|fastRestoration}
objList
attribute_1 value_1
attribute_2 value_2
attribute_n value_n
END
END
Functionality
Action: npaConfigure
ActInfo: NpaConfigureInfo
ActReply: NpaConfigureReply
This action is invoked for the NPA class to remove some objects from the NPA that the
userlabel specifies. The call of this action requires the npaType, userlabel, and the object
list to be removed from the specified NPA. The callback associated is configureNpaCall-
back, which does not manage anything of consequence.
Examples
REMOVEnpa userLabel "NpaExMeshedEtStm16"

userLabel "NpaExMeshedEtStm16"
npaType msSpring4F
objList
transObjType physicalConn
userLabel "1660_4-to-1650_2"
underlyingProtection linearMSP
userLabel "1660_4-to-1650_2"
underlyingProtection unknown
END
END
REMOVEnpa userLabel "NpaExMeshedEtStm16"

npaType msSpring4F
objList
userLabel "1660_4-to-1650_2"
modeOfOperation nonRevertive
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Add NPA (ADDnpa)
....................................................................................................................................................................................................................................
Add NPA (ADDnpa)

Synopsis
ADDnpa userLabel "userLabel"

npaType{genericRing|msSpring|msSpring4F|linearPlus|linear
Colon|ason|fastRestoration}
attribnpa_1 value_1
attribnpa_2 value_2
attribnpa_n value_n
objList
attribute_1 value_1
attribute_2 value_2
attribute_n value_n
END
END
Functionality
Action: npaConfigure
ActInfo: NpaConfigureInfo
ActReply: NpaConfigureReply
This action is invoked for the NPA class. It is used to add objects to the NPA that the
userlabel specifies. The call of this action requires the npaType userlabel and the object
list to be added to the particular NPA,. The callback that is associated with it is
configureNpaCallback, which does not manage anything of consequence.
Examples
ADDnpa userLabel "NpaExMeshedEtStm16"

npaType linearColon
objList
userLabel "regr 1660_25 etx ntw stm 4 main 3 (add)"
channelNum 2
connectionRole working
END
END
ADDnpa userLabel "NpaExMeshedEtStm16"

npaType msSpring4F
objList
userLabel "1660_4-to-1650_2"
userLabel "1660_4-to-1650_2"
....................................................................................................................................................................................................................................
March 2011
CLI Commands Add NPA (ADDnpa)
....................................................................................................................................................................................................................................
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Add Leg to Path (ADDLEGtoPath)
....................................................................................................................................................................................................................................
Add Leg to Path (ADDLEGtoPath)

Synopsis
ADDLEGtoPath
allocRule {user | automatic}
implRule {user | automatic}
endTpList
{nap | node | port}
.................................
{nap | node | port}

..................................
AttributeTp2_n "value_attrTp2_n
{nap | node | port}
.................................
................................
{nap | node | port}
..................................
END
END
Functionality
This action is invoked to add a leg to the path that the userLabel token specifies in the
command. The ActInfo structure, SG_ManageEndsInfo, is filled with the operation that
the operation token is to perform. (In this case, the value is ManageEndsInfo_operation-
_addLeg.) The type of allocation and implementation rules can be user or automatic by
allocRule and implRule tokens. All of these tokens can be specified in the command. The
field endlist is filled with a TpList that is specified in the command and its attributes. The
callback that is associated with this action is genericExtendReply, which does not manage
anything of consequence.
....................................................................................................................................................................................................................................
March 2011
CLI Commands Add Leg to Path (ADDLEGtoPath)
....................................................................................................................................................................................................................................
Examples
ADDLEGtoPath
userLabel "prova1"
allocRule user
implRule user
endTpList
node "1661-1sen"
END
END
ADDLEGtoPath
userLabel "prova2"
allocRule automatic
implRule automatic
endTpList
port "1661-1sen/2M-05"
protType sh1Plus1EToEProt
node "1661-1sen"
resType spare
END
END
ADDLEGtoPath
userLabel "pathY_broadcast"
allocRule user
implRule user
endTpList
node "VirtualConk1"
portname "pippo
resType spare
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Remove Leg from Path (REMOVELEGfromPath)
....................................................................................................................................................................................................................................
Remove Leg from Path (REMOVELEGfromPath)

Synopsis
REMOVELEGfromPath
endTpList
{nap | node | port}
.................................
{nap | node | port}

..................................
{nap | node | port}
.................................
................................
{nap | node | port}
..................................
END
END
Functionality
This action is invoked to remove a leg from the path that the userLabel token specifies in
the command. The ActInfo structure, SG_ManageEndsInfo, is filled with the operation
that the operation token is to perform. (In this case, the value is ManageEndsInfo_opera-
tion_ removeLeg.) The field endlist is filled with a TpList that is specified in command
and its attributes. The callback that is associated with this action is genericExtendReply,
which does not manage anything of consequence.
Examples
REMOVELEGfromPath
userLabel "broadcast"
endTpList
....................................................................................................................................................................................................................................
March 2011
CLI Commands Remove Leg from Path (REMOVELEGfromPath)
....................................................................................................................................................................................................................................
port "1674sx-2/r01s2b11p01"
END
END
REMOVELEGfromPath
userLabel "Lecco-Vimercate"
endTpList
nap "NE_V5/P1"
END
END
....................................................................................................................................................................................................................................
March 2011
CLI Commands Remove Leg Keep NAP in Path (REMOVELEGkeepNapInPath)
....................................................................................................................................................................................................................................
Remove Leg Keep NAP in Path (REMOVELEGkeepNapInPath)

Synopsis
REMOVELEGkeepNapInPath
endTpList
{nap | node | port}
.................................
{nap | node | port}

..................................
{nap | node | port}
.................................
................................
{nap | node | port}
..................................
END
END
Functionality
This action is invoked to remove a leg that restricts the Network Access Point (NAP)
from the path that the userLabel token specifies in the command. The ActInfo structure,
SG_ManageEndsInfo, is filled with the operation that the operation token is to perform.
(In this case, the value is ManageEndsInfo_operation_ removeLegKeepNap.) The field
endlist is filled with a TpList that is specified in the command and its attributes. The
callback that is associated with this action is genericExtendReply, which does not manage
anything of consequence.
Examples
REMOVELEGkeepNapInPath
userLabel "Milano"
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
endTpList
nap "NE_V5/P1"
END
END
....................................................................................................................................................................................................................................
March 2011
....................................................................................................................................................................................................................................
....................................................................................................................................................................................................................................
March 2011
Appendix A: List of
Abbreviations
Abbreviations
List
Acronym Meaning
ALLOC allocate
AlrType alarm type
ANSI American National Standards Institute
ASAP Alarm Severity Assignment Profile
aSAProfile
BNF Backus–Naur form
CLI Command Language Interface
CMISE Common Management Information Service
Element
CNA CMISE Network Adapter
CONFIG configure
CONSTR constraint/constraints
construct
DWDM Dense Wavelength Division Multiplexing
EML element level management
ET elementary topology
et
eOMS embedded Optical Management System
ETSI European Telecommunications Standards
Institute
GENOS Generic OS-to-OS
GMT Greenwich Mean Time
GUI Graphical User Interface
HA High Availability
...................................................................................................................................................................................................................................
8DG42097JAAA Issue 1 A-1
March 2011
List of Abbreviations Abbreviations
....................................................................................................................................................................................................................................
Acronym Meaning
HTML HyperText Markup Language
IMPL implement
MIB Management Information Base
MNGRawConn manage raw connections
MPLS Multiple Protocol Label Switching
MW-INT Middleware Interface
NAP Network Access Point; a termination point
nap object
NE network element
ne
NML Network Management Layer
NMS Network Management System
NPA Network Protection Architecture
npa
ntw network
ntwId network ID
ntwLabel network label
OI Open Interface
PDF Portable Document Format
PKT Packet
PM Performance Monitoring
pmCountRep Performance Monitoring counter report
pmDomain Performance Monitoring domain
pMeasure Performance Measurement
restRule restoration rule
sbn subnetwork
SDH Synchronous Digital Hierarchy
SEC Security; as in security database
SML Service Management Layer
SNC subnetwork controller
SONET Synchronous Optical Network
SP service pack
STM Synchronous Transport Mode
tCRProfile threshold crossing report profile
....................................................................................................................................................................................................................................
A-2 8DG42097JAAA Issue 1
March 2011
....................................................................................................................................................................................................................................
Acronym Meaning
TL1 Transaction Language 1
TMPLS Transport—Multiple Protocol Label Switching
TNA TL1 Network Adapter
TP termination point
TPs termination points
UPDALR update alarm
updList update list
UTC Universal Time Clock
VPN Virtual Private Network
WDM Wavelength Division Multiplexing
XoS XML-over-socket
....................................................................................................................................................................................................................................
8DG42097JAAA Issue 1 A-3
March 2011
....................................................................................................................................................................................................................................
....................................................................................................................................................................................................................................
A-4 8DG42097JAAA Issue 1
March 2011
Index
Numerics Audience intended for this document, ix, ix

1350 OMS ................................................................................................
applications, 1-2
B Bidirectional path
definition, 1-2
example, 5-3
supported NEs, 1-5
BNF, A-1
................................................................................................
Broadcast path
A ACT_UPDATE CLASS, 2-3 example 1, 5-9
ACT_UPDATE CLASS ObjRestClass, 8-6 example 2, 5-11
Added value modules ................................................................................................
1350 OMS HA, 1-6
C CHOWNonObj, 2-3
1350 OMS OI, 1-6
Command Description, 1-7
ADDENDSpath command, 13-21
Commands
ADDLEG path, 3-12
ACT_UPDATE CLASS, 2-3
ADDLEGtoPath command, 13-34
ACT_UPDATE CLASS ObjRestClass, 8-6
ADDnpa command, 13-32
ADDENDSpath, 13-21
Alarm Severity Assignment Profile
ADDLEG path, 3-12
See: ASAP/aSAProfile
ADDLEGtoPath, 13-34
ALLOC, A-1
ADDnpa, 13-32
ALLOC path, 3-8
ALLOC path, 3-8
ALLOC trail, 4-6
ALLOC trail, 4-6
AlrType, A-1
CHOWNonObj, 2-3
ASAP, A-1
COMMISSION path, 3-13
ASAP Management
CONFIG trail, 4-8
CORRtoaSAProfile, 7-5
CONFIGURE emldomain, 2-8
CREATE CLASS aSAProfile, 7-3
CONFIGURE et, 2-7
DELETE CLASS aSAProfile, 7-3
CONFIGURE ne, 2-8
overview, 7-2
CONFIGURE physicalConnection, 2-7
aSAProfile, A-1
CONFIGURELINKnpa, 13-9
....................................................................................................................................................................................................................................
8DG42097JAAA Issue 1 IN-1
March 2011
Index
....................................................................................................................................................................................................................................
CONFIGUREms trail, 4-8 DELETE CLASS tCAProfile, 6-10
CONNECT path, 3-15 DELETE CLASS tCRProfile, 6-7
CONNECTtrail, 13-25 DELETE conn, 9-6
CONSISTENCY, 2-10 DELETE path, 3-5
CONSmeas, 6-11 DELETE trail, 4-4
CONSTR trail, 4-5 DELETEpmTp, 6-17
CONSTRpath, 3-6 DELETEpmTransp, 6-17
CORRpmTpToTca, 6-16 DISCONNECT path, 3-15
CORRrepToMeas, 6-15 DISCONNECTtrail, 13-27
CORRtoaSAProfile, 7-5 ELEMALRMNG path, 3-16
CORRTpToMeas, 6-14 ELEMALRMNG trail, 4-11
CORRtransToMeas, 6-13 EXIT, 2-2
CREATE CLASS aSAProfile, 7-3 IMPL, 9-3, 10-9
CREATE CLASS pmCountRep, 6-8 IMPL path, 3-9
CREATE CLASS pMeasure, 6-4 IMPL trail, 4-7
CREATE CLASS restRule, 8-4 JOIN path, 3-14
CREATE CLASS tCAProfile, 6-10 JOIN trail, 4-10
CREATE CLASS tCRProfile, 6-6 JOINphysicalConnection, 10-13
CREATE conn, 9-6 manageSwitch, 13-19
CREATE path, 3-5 MNGPdhAlr, 2-11
CREATE trail, 4-4 MNGRawConn, 9-5
CREATEet, 10-6 MOVE Objects (node | port), 2-5
CREATEnode, 10-4 MOVEObjects, 13-11
CREATEntw, 10-3 MOVEport, 13-13
CREATEpath, 13-15 MULTISET node, 2-5
CREATEphysicalConn, 10-4 MULTSETnode, 13-17
CREATEsbn, 10-3 OBJECTconnection, 10-13
DEALLOC path, 3-8 PRINT, 2-2
DEALLOC trail, 4-6 PROTECT path, 3-10
DEIMPL, 9-3, 10-10 PROTECT trail, 4-9
DEIMPL path, 3-9 REMOVEENDSpath, 13-23
DEIMPL trail, 4-7 REMOVEet, 10-7
DELETE CLASS aSAProfile, 7-4 REMOVELEG path, 3-12
DELETE CLASS pmCountRep, 6-9 REMOVELEGfromPath, 13-36
DELETE CLASS pMeasure, 6-5 REMOVELEGkeepNapInPath, 13-38
DELETE CLASS restRule, 8-5 REMOVEnap, 11-4
....................................................................................................................................................................................................................................
IN-2 8DG42097JAAA Issue 1
March 2011
Index
....................................................................................................................................................................................................................................
REMOVEnode, 10-7 UPDATE et, 10-10
REMOVEnpa, 13-31 Update et, 13-30
REMOVEntw, 10-6 Update node, 13-30
REMOVEphysicalConnection, 10-7 UPDATE path, 3-3
REMOVEsbn, 10-6 UPDATE trail, 4-3
REROUTE path/trail, 13-4 UPDSNC path/trail/snc, 13-7
REROUTE path|trail, 3-7 UPDSNC path|trail|snc, 3-16
SET gmt0, 2-4 UPLOADnap, 11-3
SET local, 2-4 COMMISSION path, 3-13
SET ntwId, 2-4 CONFIG, A-1
SET ntwLabel, 2-4 CONFIG trail, 4-8
SET path, 3-3 CONFIGURE emldomain, 2-8
SET pmDomId, 6-3 CONFIGURE et, 2-7
SET restDomId, 8-3 CONFIGURE ne, 2-8
SET timeout, 2-4 CONFIGURE physicalConnection, 2-7
SET trail, 4-3 CONFIGURELINKnpa command, 13-9
SLEEP, 2-2 CONFIGUREms trail, 4-8
SPLIT path, 3-14 CONNECT path, 3-15
SPLIT trail, 4-10 Connection Management
SPLITphysicalConnection, 10-12 CREATE, 9-6
STARTmeas, 6-11 DEIMPL, 9-3
STOPmeas, 6-11 DELETE, 9-6
UNCOMMISSION path, 3-13 IMPL, 9-3
UNCORRpmTpToTca, 6-16 MNGRawConn, 9-5
UNCORRrepToMeas, 6-15 overview, 9-2
UNCORRTpToMeas, 6-14 CONNECTtrail command, 13-25
UNCORRtransToMeas, 6-13 CONSISTENCY, 2-10
UNDOREROUTE path|trail, 3-7 CONSmeas, 6-11
UNDOROUTE path/trail, 13-6 CONSTR, A-1
UPDALR path, 3-16 CONSTR trail, 4-5
UPDALR trail, 4-11 CONSTRpath, 3-6
UPDATE CLASS, 13-29 Conventions
UPDATE CLASS pmCountRep, 6-8 typographical, xi
UPDATE CLASS pMeasure, 6-4 CORRpmTpToTca, 6-16
UPDATE CLASS restRule, 8-4 CORRrepToMeas, 6-15
UPDATE CLASS tCRProfile, 6-7 CORRtoaSAProfile, 7-5
....................................................................................................................................................................................................................................
March 2011
Index
....................................................................................................................................................................................................................................
CORRTpToMeas, 6-14 DISCONNECT path, 3-15
CORRtransToMeas, 6-13 DISCONNECTtrail command, 13-27
CREATE CLASS aSAProfile, 7-3 Documentation
CREATE CLASS pmCountRep, 6-8 font usage, xi
CREATE CLASS pMeasure, 6-4 how to order, xiii
CREATE CLASS restRule, 8-4 list of available customer documentation, xi, xii
CREATE CLASS tCAProfile, 6-10 ................................................................................................
CREATE CLASS tCRProfile, 6-6 E ELEMALRMNG path, 3-16

CREATE conn, 9-6 ELEMALRMNG trail, 4-11
CREATE path, 3-5 elementary topology
CREATE trail, 4-4 See: et/ET
CREATEet, 10-6 et/ET, A-1
CREATEnode, 10-4 EXIT, 2-2
CREATEntw, 10-3 ................................................................................................
CREATEpath command, 13-15 F Font usage, xi
CREATEphysicalConn, 10-4 ................................................................................................
CREATEsbn, 10-3 G Glossary, xi

Customer documentation GMT, A-1
See: Documentation
................................................................................................
................................................................................................
H Help, xi
D DEALLOC path, 3-8
................................................................................................
DEALLOC trail, 4-6
I IMPL, 9-3, 10-9, A-2
DEIMPL, 9-3, 10-10
IMPL path, 3-9
DEIMPL path, 3-9
IMPL trail, 4-7
DEIMPL trail, 4-7
................................................................................................
DELETE CLASS aSAProfile, 7-4
J JOIN path, 3-14
DELETE CLASS pmCountRep, 6-9
DELETE CLASS pMeasure, 6-5 JOIN trail, 4-10
DELETE CLASS restRule, 8-5 JOINphysicalConnection, 10-13

................................................................................................
DELETE CLASS tCAProfile, 6-10
DELETE CLASS tCRProfile, 6-7 L Legacy support, 1-4
DELETE conn, 9-6 ................................................................................................
DELETE path, 3-5 M manageSwitch command, 13-19

DELETE trail, 4-4 Manuals
DELETEpmTp, 6-17 See: Documentation
DELETEpmTransp, 6-17 MNGPdhAlr, 2-11

MNGRawConn, 9-5, A-2
....................................................................................................................................................................................................................................
March 2011
Index
....................................................................................................................................................................................................................................
MOVE Objects (node | port), 2-5 CONSTR, 3-6
MOVEObjects command, 13-11 CREATE, 3-5
MOVEport command, 13-13 DEALLOC, 3-8, 3-9
MULTISET node, 2-5 DELETE, 3-5
MULTSETnode command, 13-17 DISCONNECT, 3-15
................................................................................................ IMPL, 3-9
N NAP Management JOIN, 3-14
overview, 11-2 PROTECT, 3-10
REMOVEnap, 11-4 REMOVELEG, 3-12
UPLOADnap, 11-3 REROUTE, 3-6
nap/NAP, A-2 SET, 3-3
nap/NPA, A-2 SPLIT, 3-14
NEs UNCOMMISSION, 3-13
those supported for this release, 1-5 UNDOREROUTE, 3-6
Network UPDATE, 3-3
example, 5-2 Various Updates, 3-16
Network Access Point Paths

See: nap/NAP bidirectional path example, 5-3
network ID broadcast path example 1, 5-9
See: ntwId
broadcast path example 2, 5-11
network label
See: ntwLabel example of a path that uses HO trails, 5-26
ntw, A-2 example of protected paths with drop and continue,

5-5
ntwId, A-2
Performance measurement
ntwLabel, A-2 See: pMeasure
................................................................................................ Performance Monitoring
See: PM
O OBJECTconnection, 10-13
Performance Monitoring counter report
On-line help
See: pmCountRep
See: Help
Performance Monitoring domain
................................................................................................
See: pmDomain
P PATH
PM, A-2
examples, 3-18 PM Management
Path Management CONSmeas, 6-11
ADDLEG, 3-12 CORRpmTpToTca, 6-16
ALLOC, 3-8 CORRrepToMeas, 6-15
COMMISSION, 3-13 CORRTpToMeas, 6-14
CONNECT, 3-15 CORRtransToMeas, 6-13
....................................................................................................................................................................................................................................
March 2011
Index
....................................................................................................................................................................................................................................
DELETEpmTp, 6-17 Restoration Rule Management
DELETEpmTransp, 6-17 ACT_UPDATE CLASS restRule, 8-6
pmCountRep, 6-8 CREATE CLASS restRule, 8-4
pMeasure, 6-4 DELETE CLASS restRule, 8-4
SET, 6-3 overview, 8-2
STARTmeas, 6-11 SET restDomId, 8-3
STOP, 6-11 UPDATE CLASS restRule, 8-4
tCAProfile, 6-10 restRule, A-2
tCRProfile, 6-6 rmBatchUtil Tool
UNCORRpmTpToTca, 6-16 command syntax, 12-2
UNCORRrepToMeas, 6-15 error handling example 1, 12-3
UNCORRTpToMeas, 6-14 error handling example 2, 12-3
UNCORRtransToMeas, 6-13 error handling example 3, 12-4
pmCountRep, A-2 executing errors, 12-2
pmDomain, A-2 syntax errors, 12-2
pMeasure, A-2 ................................................................................................
PRINT, 2-2 S Safety information, ix

PROTECT path, 3-10 sbn, A-2
PROTECT trail, 4-9 SET gmt0, 2-4
................................................................................................ SET local, 2-4
R REMOVEENDSpath command, 13-23 SET ntwId, 2-4
REMOVEet, 10-7 SET ntwLabel, 2-4
REMOVELEG path, 3-12 SET path, 3-3
REMOVELEGfromPath command, 13-36 SET pmDomId, 6-3
REMOVELEGkeepNapInPath command, 13-38 SET restDomId, 8-3
REMOVEnap, 11-4 SET timeout, 2-4
REMOVEnode, 10-7 SET trail, 4-3
REMOVEnpa command, 13-31 SLEEP, 2-2
REMOVEntw, 10-6 SNC, A-2
REMOVEphysicalConnection, 10-7 SPLIT path, 3-14
REMOVEsbn, 10-6 SPLIT trail, 4-10
REROUTE path/trail command, 13-4 SPLITphysicalConnection, 10-12
REROUTE path|trail, 3-7 STARTmeas, 6-11
Restoration rule STOPmeas, 6-11
See: restRule
subnetwork
See: sbn
....................................................................................................................................................................................................................................
March 2011
Index
....................................................................................................................................................................................................................................
Subnetwork controller Trails
See: SNC
example, 5-21
Synchronous Transport Mode
example of a path that uses HO trails, 5-26
See: STM
Typographical conventions, xi
................................................................................................
................................................................................................
T tCRProfile, A-2
U UNCOMMISSION path, 3-13
Technical documentation
See: Documentation UNCORRpmTpToTca, 6-16
Termination Points (TPs) UNCORRrepToMeas, 6-15
See: TPs
UNCORRTpToMeas, 6-14
Threshold crossing report profile
UNCORRtransToMeas, 6-13
See: tCRProfile
UNDOREROUTE path|trail, 3-7
Topology Management
UNDOROUTE path/trail command, 13-6
CREATE, 10-3
Universal Time Clock
DEIMPL, 10-9
See: UTC
IMPL, 10-9 UPDALR, A-3
JOIN, 10-12 UPDALR path, 3-16
OBJECT, 10-12 UPDALR trail, 4-11
overview, 10-2 Update alarm (TPs)
REMOVE, 10-3 See: UPDALR
SPLIT, 10-12 UPDATE CLASS command, 13-29
UPDATE, 10-9 UPDATE CLASS pmCountRep, 6-8
TPs, A-3 UPDATE CLASS pMeasure, 6-4
Trail Management UPDATE CLASS restRule, 8-4
ALLOC, 4-6 UPDATE CLASS tCRProfile, 6-7
CONFIG, 4-8, 4-8 UPDATE et, 10-10
CONSTR, 4-5 Update et command, 13-30
CREATE, 4-4 Update list (TPs)

See: updList
DEALLOC, 4-6
Update node command, 13-30
DEIMPL, 4-7
UPDATE path, 3-3
DELETE, 4-4
UPDATE trail, 4-3
IMPL, 4-7
updList, A-3
JOIN, 4-10
UPDSNC path/trail/snc command, 13-7
PROTECT, 4-9
UPDSNC path|trail|snc, 3-16
SET, 4-3
UPLOADnap, 11-3
SPLIT, 4-10
User guides
UPDATE, 4-3
See: Documentation
Various updates, 4-11
....................................................................................................................................................................................................................................
March 2011
Index
....................................................................................................................................................................................................................................
UTC, A-3
................................................................................................
W Web Portal, 1-4, 1-4
....................................................................................................................................................................................................................................
March 2011

1350 OMS CLI Reference 8DG42097JAAA

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

1350 OMS CLI Reference 8DG42097JAAA

Uploaded by

Copyright:

Available Formats

Title page

1350 OMS 9.1.1

Information product support

About this document

Reason for revision ...................................................................................................................................................................... ix

Safety information ........................................................................................................................................................................ ix

Intended audience ......................................................................................................................................................................... ix

How to use this information product ..................................................................................................................................... ix

Conventions used .......................................................................................................................................................................... xi

Related documentation ............................................................................................................................................................... xi

How to order ................................................................................................................................................................................ xiii

How to comment ........................................................................................................................................................................ xiii

Overview ...................................................................................................................................................................................... 1-1

1350 OMS Overview ............................................................................................................................................................... 1-2

Command Description ............................................................................................................................................................ 1-7

2 Common Command Verbs

Overview ...................................................................................................................................................................................... 2-1

PRINT, SLEEP, and EXIT Commands ............................................................................................................................. 2-2

CHOWNonObj and ACT_UPDATE Commands .......................................................................................................... 2-3

SET Commands ......................................................................................................................................................................... 2-4

MOVE and MULTISET Commands ................................................................................................................................. 2-5

CONFIGURE Command ....................................................................................................................................................... 2-7

CONSISTENCY Command ............................................................................................................................................... 2-10

NT MNGPdhAlr ..................................................................................................................................................................... 2-11

Overview ...................................................................................................................................................................................... 3-1

Path Management ..................................................................................................................................................................... 3-2

Path Management: SET and UPDATE ............................................................................................................................. 3-3

Path Management: CREATE and DELETE .................................................................................................................... 3-5

Path Management: CONSTR, REROUTE, and UNDOREROUTE ...................................................................... 3-6

Path Management: ALLOC and DEALLOC .................................................................................................................. 3-8

Path Management: IMPL and DEIMPL ........................................................................................................................... 3-9

Path Management: PROTECT .......................................................................................................................................... 3-10

Path Management: ADDLEG and REMOVELEG .................................................................................................... 3-12

Path Management: COMMISSION and UNCOMMISSION ................................................................................ 3-13

Path Management: SPLIT and JOIN ............................................................................................................................... 3-14

Path Management: CONNECT and DISCONNECT ................................................................................................ 3-15

Path Management: Various Updates ................................................................................................................................ 3-16

SAVEROUTE/RECALLROUTEpath/trail ................................................................................................................... 3-17

Path Examples ......................................................................................................................................................................... 3-18

Overview ...................................................................................................................................................................................... 4-1

Trail Management ..................................................................................................................................................................... 4-2

Trail Management: SET and UPDATE ............................................................................................................................. 4-3

Trail Management: CREATE and DELETE ................................................................................................................... 4-4

Trail Management: CONSTR ............................................................................................................................................... 4-5

Trail Management: ALLOC and DEALLOC ................................................................................................................. 4-6

Trail Management: IMPL and DEIMPL .......................................................................................................................... 4-7

Trail Management: CONFIG and CONFIG .................................................................................................................... 4-8

Trail Management: PROTECT ............................................................................................................................................ 4-9

Trail Management: Various Updates ............................................................................................................................... 4-11

5 Path Management and Trail Management Examples

Overview ...................................................................................................................................................................................... 5-1

Network example ...................................................................................................................................................................... 5-2

Bidirectional Path ..................................................................................................................................................................... 5-3

Protected Paths with Drop and Continue ......................................................................................................................... 5-5

Broadcast Path ........................................................................................................................................................................... 5-9

Trails example ......................................................................................................................................................................... 5-21

Path that Uses HO Trails ...................................................................................................................................................... 5-26

Overview ...................................................................................................................................................................................... 6-1

PM Management Overview .................................................................................................................................................. 6-2

PM Management: SET ............................................................................................................................................................ 6-3

PM Management: pMeasure Object .................................................................................................................................. 6-4

PM Management: tCRProfile Object ................................................................................................................................ 6-6

PM Management: pmCountRep Object ........................................................................................................................... 6-8