Apollo

STMS Getting Started and Administration Guide

V12
Document Revision: 01
Published: June 2024
© 2024 Ribbon Communications Operating Company, Inc. © 2024 ECI Telecom Ltd. All rights reserved.
This is a legal agreement between you, the end user, and ECI Ltd. (“ECI”). BY OPENING THE DOCUMENTATION AND/OR DISK
PACKAGE, YOU ARE AGREEING TO BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS
OF THIS AGREEMENT, PROMPTLY RETURN THE UNOPENED DOCUMENTATION AND/OR DISK PACKAGE AND THE
ACCOMPANYING ITEMS (INCLUDING WRITTEN MATERIALS AND BINDERS OR OTHER CONTAINERS), TO THE PLACE FROM
WHICH YOU OBTAINED THEM.
All documentation and/or disk and all information and/or data contained in the documentation and/or disk ["ECI's Proprietary"] is ECI's
proprietary and is subject to all copyright, patent, and other laws protecting intellectual property, and any international treaty provisions,
as well as any specific agreement protecting ECI's rights in the aforesaid information. Any use of ECI's Proprietary for any purposes
[included but not limited: published, reproduced, or disclosed to third parties, in whole or in part] other than those for which it was
disclosed, without the express prior written permission of ECI, is strictly forbidden.
ECI's Proprietary is provided "AS IS" and may contain flaws, omissions, or typesetting errors. No responsibility and or liability
whatsoever are assumed by ECI for you or any other party, for the use thereof, nor for the rights of third parties, nor for any loss or
damage whatsoever or howsoever caused, arising directly or indirectly in connection with ECI's Proprietary, which may be affected in
any way by the use and/or dissemination thereof. ECI reserves the right, without prior notice or liability, to make changes in equipment
design or specifications including any change in and to the ECI's Proprietary.
Any representation(s) in ECI's Proprietary concerning performance of ECI's product(s) are for informational purposes only and are not
warranties of product performance or otherwise, either express or implied. No warranty is granted nor liability assumed in relation
thereto, unless specifically undertaken in ECI's sales contract or order confirmation. ECI's Proprietary is periodically updated, and
changes will be incorporated in subsequent editions. All graphics included in this document are for illustrative purposes only and might
not correspond with your specific product version.
The documentation and/or disk and all information contained therein is owned by ECI and is protected by all relevant copyright, patent,
and other applicable laws and international treaty provisions. Therefore, you must treat the information contained in the documentation
and disk as any other copyrighted material (for example, a book or musical recording).
Other Restrictions. You may not rent, lease, sell, or otherwise dispose of ECI's Proprietary, as applicable.
YOU MAY NOT USE, COPY, MODIFY, OR TRANSFER THE DOCUMENTATION AND/OR DISK OR ANY COPY IN WHOLE OR PART,
EXCEPT AS EXPRESSLY PROVIDED IN THIS LICENSE. ALL RIGHTS NOT EXPRESSLY GRANTED ARE RESERVED BY ECI.
All trademarks mentioned herein are the property of their respective holders.
Notwithstanding the generality of the aforementioned, you expressly waive any claim and/or demand regarding liability for indirect,
special, incidental, or consequential loss or damage which may arise in respect of ECI's Proprietary contained therein, howsoever
caused, even if advised of the possibility of such damages.
The end user hereby undertakes and acknowledges that they read the "Before You Start/Safety Guidelines" instructions (when provided
by ECI) and that such instructions were understood by them. ECI shall not be liable to you or to any other party for any loss or damage
whatsoever or howsoever caused, arising directly or indirectly in connection with you fulfilling and/or failure to fulfill in whole or in part
the "Before You Start/Safety Guidelines" instructions.

Ribbon's qualification lab is accredited by A2LA for competence in electrical testing according to the International
Standard ISO IEC 17025-2017 General Requirements for the Competence of Testing and Calibration Laboratories.\

Ribbon's management applications run on VMWare virtualization hypervisors.

Catalog #: X66945
Drawing #: 497006-2412-148-A00
Contents
STMS Getting Started and Administration Guide .......................................................... 1
STMS Getting Started and Administration Guide Revision History ............................. 2
Introducing STMS.............................................................................................................. 3
STMS Key Features Overview .........................................................................................................................3
Inventory Information in STMS................................................................................................................... 4
Fault Management with the STMS ............................................................................................................. 4
Configuration Management with the STMS................................................................................................ 5
PM TCA Reports......................................................................................................................................... 6
Security Features at the NE Level.............................................................................................................. 7
Built-In Test................................................................................................................................................. 7
STMS Ease of Use..................................................................................................................................... 7
Network Communications Control.............................................................................................................. 8
Plug and Play ........................................................................................................................................... 10
STMS System Overview and Architecture .....................................................................................................10
STMS System Architecture .......................................................................................................................11
Database Backup Using RDR ........................................................................................................................12
STMS Server and STMS Client Startup ......................................................................... 13
STMS Server..................................................................................................................................................13
Start the STMS Server as a Daemon....................................................................................................... 13
Start the STMS Server Not as a Daemon ................................................................................................ 13
Start the STMS Server as an STMS User................................................................................................ 14
SSH Connections Option ...............................................................................................................................14
Set Up SSH in Windows........................................................................................................................... 14
Set Up SSH in Solaris .............................................................................................................................. 15
Start and Log in to the STMS Client...............................................................................................................15
STMS Client Settings ...................................................................................................... 20
Define View Preferences ................................................................................................................................20
Alarm Preferences..........................................................................................................................................22
Set the Alarm View Preferences in the STMS.......................................................................................... 23
Set the Audio Notification Preferences in the STMS ................................................................................ 23
Add an Alarm Notification in the STMS .................................................................................................... 23
Edit an Alarm Notification in the STMS .................................................................................................... 25
Delete an Alarm Notification in the STMS ................................................................................................ 25
Reorder Alarm Notifications in the STMS................................................................................................. 26

Ribbon Communications Inc. Proprietary iii

 Contents

Enable Audible Alarm Notifications in the STMS...................................................................................... 26

Pause Alarm Notifications in the STMS.................................................................................................... 26
Connection Options........................................................................................................................................26
Change the Ping Interval.......................................................................................................................... 26
Set the Number of Ping Failures .............................................................................................................. 26
Define Filtering Preferences...........................................................................................................................27
Manage Licenses ...........................................................................................................................................28
The STMS Client .............................................................................................................. 38
The Explorer Pane .........................................................................................................................................38
View Options ..................................................................................................................................................39
Network Element Status View .................................................................................................................. 39
Network Element Layout View ................................................................................................................. 41
Chassis View ............................................................................................................................................ 42
Properties View ........................................................................................................................................ 45
View the Alarm and Log Panel .......................................................................................................................48
Alarm Colors and Indications ................................................................................................................... 49
STMS Status Bar...................................................................................................................................... 49
Exit and Shut Down the STMS.......................................................................................................................50
Users and Security.......................................................................................................... 51
STMS User Groups ........................................................................................................................................51
View Defined Users ........................................................................................................................................52
Define Password Requirements.....................................................................................................................53
Create a User .................................................................................................................................................55
Edit a User......................................................................................................................................................57
Delete a User .................................................................................................................................................59
Reset a User's Password ...............................................................................................................................60
Change the User Group for a User ................................................................................................................62
View Active User Sessions .............................................................................................................................62
End a User Session........................................................................................................................................63
View Audit Events...........................................................................................................................................64
Activity Logs ...................................................................................................................................................65
View the Activity Log ................................................................................................................................ 66
View the Security Log............................................................................................................................... 67
Archive of Activity Logs, Events, and Alarms .................................................................................................68
Define Archive Settings ............................................................................................................................ 68
Manually Archive Records........................................................................................................................ 69
View Archived Records ............................................................................................................................ 70

Ribbon Communications Inc. Proprietary iv

 Contents

Backup and Restore on Linux ........................................................................................................................71

Ribbon Communications Inc. Proprietary v

STMS Getting Started and Administration
Guide
This document describes the STMS GUI and its main functions.

Ribbon Communications Inc. Proprietary 1

 STMS Getting Started and Administration Guide Revision History

STMS Getting Started and Administration

Guide Revision History
Revision History

Revision No. Pages Changed Description of Changes

01 N/A First revision

Ribbon Communications Inc. Proprietary 2

 Introducing STMS

Introducing STMS
Shade Tree Management System (STMS) is the element management, service provisioning, and
monitoring solution for the Apollo series. STMS provides fault, configuration, administration, performance,
and security (FCAPS) management, as well as powerful service management capabilities for a complete
suite of Wavelength Division Multiplexing (WDM) and Optical Transport Network (OTN) services. The main
STMS features include:
• Integrated management: STMS includes smooth integration with the LightSOFT® management
system. STMS can also be operated in standalone mode on a Linux PC, a cost-effective management
option for small networks.
• Intelligent troubleshooting: STMS offers advanced troubleshooting tools to detect and resolve
network issues, such as Ethernet, WDM, and OTN service failures, misconfiguration, incorrect
software versions, and disconnected interfaces. STMS reduces the time to provision, deploy, and
define network elements, cards and interfaces by providing a user-friendly GUI to simplify the
configuration process.
• Efficient preconfiguration: STMS supports preconfiguration of cards and interfaces. After installing
the actual equipment, STMS verifies the configuration, and sends notification if there is a configuration
mismatch.
• Comprehensive reports: STMS gathers, processes, and stores statistical information that is
collected by the network elements to generate complete and accurate performance management
reports.
Refer also to:
• STMS Key Features Overview
• STMS System Overview and Architecture
• Database Backup Using RDR

STMS Key Features Overview

STMS provides various provisioning, monitoring, and management capabilities.
• LightSOFT Integration: STMS can be integrated with LightSOFT to support inventory management,
alarm management, WDM and OTN service management. It supports Multi Technology Network
Management (MTNM) CORBA-based interface. In addition, the rest of STMS functionality is available
with GUI cut-through (GCT). LightSOFT delivers comprehensive support and management
capabilities across multiple layers, networks, and technologies. The GCT enables LightSOFT to open
an STMS window in a specific context and allows the LightSOFT operator to get to it quickly, thus
providing a mechanism for performing any operation that is available in STMS but not in LightSOFT.

Note
The MTNM CORBA-based interface (NBI) is a fully integrated add-on capability that is
available on a cost basis. The feature is available if a license has been purchased, is current,
and has not exceeded its limits (see Manage Licenses).

• Carrier Class Network Management: STMS works in a highly-available, warm-standby, redundant

configuration, eliminating a single point of failure (SPOF) and allowing carriers to minimize downtime.
STMS clients are synchronized with the Apollo CLI to enable operators and engineers to coordinate
and enable troubleshooting. STMS uses efficient configuration change events sent from the device to
the STMS that communicate only with those configuration parts that changed.

Ribbon Communications Inc. Proprietary 3

 Introducing STMS

STMS Network Environment

• Comprehensive Network Planning: The comprehensive and accurate data stored in the STMS
database enable effective network planning. Managed device, inventory, and available slot reports
assist capacity planning and inventory control. Device-monitoring capabilities prevent problems from
reaching a critical stage by providing proactive monitoring of components, such as CPU utilization, file
system size, memory usage, and device temperature, sending alerts when thresholds are exceeded.
Refer also to:
• Inventory Information in STMS
• Fault Management with the STMS
• Configuration Management with the STMS
• PM TCA Reports
• Security Features at the NE Level
• Built-In Test
• STMS Ease of Use
• Network Communications Control
• Plug and Play

Inventory Information in STMS

Each Apollo module (shelf, card, pluggable transceiver) is equipped with a nonvolatile memory (ID-PROM)
that stores its inventory information. The following inventory information can be retrieved via the CLI or STMS
for each card:
• Vendor name
• Serial number
• Part number
• Software version
• Hardware version

Fault Management with the STMS

Operators are notified of changes in the NE through one of the following notification types:
• Alarm notifications: Notify about events that require operator involvement. Alarm notifications are
reported concurrently via three different methods:
◦ Automatic output message to external management system after stabilization period
◦ Visual indicator in the NE
◦ Audible/visible indicators at central office under control of the NE

Ribbon Communications Inc. Proprietary 4

 Introducing STMS

• Non-alarm notifications: Notify about changes in the system. These notifications are sent as
automatic output messages to the external management system without waiting for a stabilization
period.
Both alarm and non-alarm notifications are reported to STMS as well as to external management systems
using an SNMP agent. A system of severity levels is used to prioritize the alarms in the order of urgency:
• Critical: Service affecting. Always requires immediate attention to restore service. Used when the
managed entity is totally out of service and its capability must be restored.
• Major: Service affecting. Gives notice that attention is required, but it is not an immediate emergency.
• Minor: Non service affecting. Requires corrective action in order to prevent a more serious fault.
• Warning: Non service affecting. A situation which is not the cause of traffic stoppage or degradation,
but which an operator may still want to be notified. Warning alarms use the minor LEDs and relays.
• Non-alarmed: Non service affecting. Extended severity for transient condition reports (such as
protection switch events, timing-switching, or 1-day TCA reports).
Additional optional methods can be provided for alarm control and display:
• Terminal displays, including LEDs that indicate malfunctions of specific plug-in units or transmission
paths.
• Alarm contacts, delivering critical, major, and minor alarm indications to the station alarm bus
• Four input alarm and four output alarm dry contacts, to be explicitly defined by the user. By default
there is no configuration of external dry contacts.
• Rack alarm buzzer with station acknowledgment mechanism.
• Alarm server, delivering network aggregated alarms from LightSOFT to the operator's Central
Monitoring Station (CMS).
• Alarm inputs from in-station devices (such as security sensors, fire detectors, external monitoring
equipment) and other in-station telecommunication equipment (like flexible multiplexers and DWDM
units).
Each managed entity (such as a card, port, or interface) that supports fault management functionality works
with a severity profile, a list of all alarm and non-alarm notifications that can be suppressed. Using the
severity profile, a user can modify the severity of each alarm and suppress reporting of selected alarm or
non-alarm reports. Apollo NEs also provide log functionality:
• All reported alarms are logged to a persistent NE alarm log.
• All non-alarm reports (if so defined in the severity profile) are logged to a persistent NE event log.
There are several levels of alarm report suppression:
• Per specific alarm: Suppressed by changing the reporting attribute of the specific alarm in a specific
severity profile.
• Per managed entity: Suppressed by changing the alarm master mask attribute value.
• AINS: Suppressed until getting into service for the first time (future).
Current reported alarms can be retrieved via CLI, STMS, and SNMP requests. In addition, CLI and STMS
allow retrieval of reported and non-reported alarm conditions per managed entity.

Configuration Management with the STMS

The Apollo platform provides enhanced configuration features. From the STMS, you can perform user
configuration, implicit configuration, and preplanned and manual configuration.

User Configuration
A required part of Apollo platform installation is for you to define parameter settings for I/O and fabric card
slots. Common equipment cards (such as controller, power supply, and fan cards) are implicitly defined by
the NE.

Ribbon Communications Inc. Proprietary 5

 Introducing STMS

In addition, there are other instances when you must define equipment entities. For example, cards with
unique multiple configurations for supported entities need manual configuration. User configuration is also
required for preplanned and manual configuration.

Implicit Configuration
Implicit configuration is the ability of an NE to define equipment and/or supported entities without operator
intervention. This feature is supported by the Apollo as follows:
• Implicit equipment configuration is supported for the main service shelf, including components
requiring minimal equipment configuration. As part of implicit configuration, the main shelf defines the
minimal equipment configuration, including its RCP, fan unit (FCM) and power supplies (PFMs),
according to their default values. In addition, the main shelf defines RCPs of subtending shelves
according to their default values, and controller cards of subtending passive shelves.
• Cards with unique configuration of supported entities enable the user to simply set the card type
and all ports, and the supported entities are implicitly defined according to their default values. This
applies to the passive optics cards (e.g., DCFs, splitters/couplers), amplifiers, some ports in Add-
ROADMs, and service cards with non-FRU transceivers. This category also includes cards with
multiple configurations. In this case, the user sets the card type, and the card is defined according to
its default values; the supported entities are not defined. This would include, for example, client cards,
line cards, and transponders.
• Ports with unique configuration of supported entities enable the user to define the port type, and
all supported entities are implicitly defined. This would include, for example, service cards, data cards,
and ROADMs.

Preplanned and Manual Configuration

Apollo platforms support preplanned and manual configuration initiated by a user. The following modes are
supported:
• Manual configuration, performed by a single command from the CLI.
• Transfer of a configuration file to the Apollo NE to be saved and executed, immediately or later.
• User sends command after command from the external management.
As part of manual configuration, you can perform the following activities:
• Assign an ID number to subtending service and passive shelves.
• Create and configure an empty slot.
• Delete populated slot and assign it to another FRU.
• Modify a populated slot to another FRU type.
You can define multiple entities of the same type using the Copy command, via the CLI or STMS. For
example, if you have defined a slot, you do not have to repeat the changes manually to another slot in the
same or other shelves. You can use this slot as a template and copy its configuration to another slot. This
functionality is also supported for cards and shelves of the same type.

PM TCA Reports
Apollo as a transport system provides performance monitoring interval collection on its transport entities,
such as ports and interfaces. By default, performance monitoring is enabled, and performance monitoring
data is collected for L1 service cards and photonic cards with monitoring points. Apollo also supports
performance monitoring on the OSC-2M and OSC-100M ports used for in-band management.
The NE collects performance monitoring information every 15 minutes, as well as compiling historic
performance monitoring data for each entity at the end of each day. The collected information is stored in
nonvolatile memory in the NE in a single zipped file for each performance monitoring interval.

Ribbon Communications Inc. Proprietary 6

 Introducing STMS

The NE can store up to 95 historical performance monitoring files for 15-minute intervals and seven historical
performance monitoring files for 1-day intervals. Any external managed system can acquire the performance
monitoring files from the NE.
Performance monitoring profiles contain a list of performance monitoring threshold setting values defined for
each technology. Only entities supporting performance monitoring interval functionality can be associated
with a performance monitoring profile.
Performance monitoring TCA reports follow transport system standards as follows:
• 15-minute TCAs are reported as standing condition reports with alarm severity types.
• 1-day TCAs are reported as transient condition reports with the non-alarmed severity type.
• Performance monitoring TCAs are defined in the severity profile for each technology, following the
alarms and events approach.
• Current interval and historical performance monitoring information per entity can be retrieved upon
user request. Current intervals and historical intervals have a suspect flag attribute indicating if the
interval information is reliable or not.
• The flag is enabled by configuration changes on the monitored entities, such as resetting counters
and performance monitoring updates.
For more information, see the Performance Monitoring chapter in the Performance Monitoring Guide.

Security Features at the NE Level

This following security features are supported at the NE level:
• NE access control
• NE password
• Cryptographic solutions
• STMS as a Certificate Authority
• Secured communication in Neptune
• Enhanced security for communication channels

Built-In Test
STMS provides Built-In Testing (BIT).
The BIT hardware and its related software assist in identification of any faulty card in the system. BIT checks
are performed during power up and at periodic intervals afterwards.
There are three BIT levels:
• BIT failed: Card devices don't work (or partially work); service is affected.
• BIT degraded: Service might be somewhat affected (for example, higher degree of BER).
• BIT slightly degraded: Service not affected but there is some unusual or non-optimal behavior (for
example, a heated device). This level usually doesn't require immediate technician attention.
Unsuccessful BIT raises an alarm according to the BIT level, including a list of all associated error codes and
some explanation. Based on this information, the technician decides how to fix the problem.

STMS Ease of Use

Apollo embedded management provides enhanced features that make operation of the system very simple,
easy, and user-friendly.
The Apollo embedded management features include:
• You assign a card or define a port; the NE implicitly defines the supported entities and updates the
STMS.
• You define a port number and port type; the NE implicitly defines the port layers.
• Apollo platforms support plug-and-play functionality. Using auto-discovery, each plugged FRU is
detected and its inventory reported.

Ribbon Communications Inc. Proprietary 7

 Introducing STMS

• Fiber connectivity supports several applications:

◦ Power equalization
◦ Diagnostic
◦ Alarm correlation
• Unified planning tools support:
◦ Network resource optimization and simplified operation
◦ Download of NE configuration, intra-connectivity, and network topology
◦ Simplified network expansion

Network Communications Control

Routing and Forwarding Functionality

The routing and forwarding capabilities of the NE platforms are based on standard OSPF dynamic routing,
suitable for small, medium, and larger networks, and including a richer set of features for network
communications management.
In the NE platforms, the main control processor subsystem is responsible for communications with external
NEs and management stations. Communications with other NEs is via the GCC in each OTN link, OSC, in-
band Ethernet, or external DCN.
An Ethernet interface is used to for communication. The controller subsystem can also communicate with a
desktop or laptop PC-based LCT-STMS or ShadeTree OS via a serial interface or Ethernet. It also provides
alarm outputs.

Management Channel with Dynamic OSPF

A management channel enables operators to integrate several platforms with their own workstations and to
pass this management traffic through the NEs. The operator sets up an IP-based DCN to carry IP packets
between the management stations and the NEs. The DCN is composed of Embedded Communication
Channels (ECCs) supported by the equipment itself and an external DCN supported by standard data
equipment.
The management system performs IP forwarding between all network interfaces, implementing dynamic
OSPF routing over these network interfaces to automatically determine the routing table. OSPF can be
defined for any subset of network interfaces and supports:
• P2P and broadcast interfaces
• Up to four OSPF areas
• Address summarization
• Area Border Router functionality
• Autonomous System Border Router functionality, including redistribution of static routes
• Loopback address as a router ID
• Configuration of HELLO protocol parameters
• "Passive" interfaces to allow distribution of routes to attached devices
OSPF functionality enables a wide range of DCN configurations, adds resiliency to management
communications between NEs and the management stations, and reduces the ECC load, for a significant
improvement in management performance and NE capacity.
Under dynamic ECC routing, NEs ping each other through the available ECC interfaces and build their own
routing tables. Working with dynamic routing tables that respond to real-time circumstances simplifies ECC
planning and maintenance, and reduces the ECC load by making it unnecessary to reserve ECC protection
paths in advance. There is also no need to plan ECC rings, since dynamic ECC routing enables NEs to
automatically set up new routes if the existing ones fail.

Ribbon Communications Inc. Proprietary 8

 Introducing STMS

Flexible Support for Management Mixtures

Management information is transmitted from the NMS/EMS to individual NEs through one of the following
mechanisms:
• External DCN
• GCC channel
• In-band Ethernet signals
• OSC card
The management system fully integrates the GCC, OSC, in-band Ethernet, and external DCN management
channels, thus providing the operator with the flexibility to select the most appropriate management channel.
Operators can even mix the different channels in a network or in the same platform, as shown here.

Channel Mixing

General Communications Channel

The management system supports in-band management utilizing the GCC incorporated in Layer 1 service
cards (either standalone or fabric I/O cards). The GCC enables remote management of equipment at any
site where optical channels are dropped. This can increase margins and extend distances of optical links as
OSC filters are eliminated.
The management system supports GCC0, GCC1, and GCC2. GCC1 and GCC2, integrated in the ODU
overhead bytes, are usually used when transmitting management over a third-party domain that is not based
on our equipment. GCC0 is transmitted over OTU overhead bytes and terminated every time the OTN signal
is terminated. GCC is available for OTU1, OTU2, OTU3, and OTU4 signals.

In-Band Ethernet Channel

NE platforms can transmit management information over a dedicated VLAN via in-band Ethernet signals. In-
band Ethernet can be transmitted over GbE, 10 GbE, and 100 GbE interfaces. In-band Ethernet
management is only available when using Layer 2 cards. The Layer 2 cards terminate the VLAN and extract
the management information.
IP over PW or Management VLAN service is applicable for MPLS-TP NPT NEs (not IP-MPLS NPT NEs).
Management VLAN service is an Ethernet in-band management control service using in-band Management

Ribbon Communications Inc. Proprietary 9

 Introducing STMS

Communication Channels (MCC). You can create/edit/change a Management VLAN service directly through
the Create L2VPN Service window in LightSOFT.

Optical Supervisory Channel

The management systems support OSC for WDM link management when the data channels themselves
don't include embedded communication channels or if there are no channel drops, as at an in-line amplifier
site. The OSC is used as a communication channel to enable communication and control.
The OSC implementation is either through dedicated OSC cards or integrated into certain amplifier models.
OSC options include FE at 1310 nm for CWDM links, FE at 1510 nm for DWDM links, or 2 Mbps at 1310 nm
for extended spans (OSC card only). The OSC card supports:
• Six FE management ports, allowing management information connections of up to six degrees, using
1510 nm (DWDM) and 1310 nm (CWDM) SFPs.
• Two 2-Mbps management ports for extended reach applications, using 1310 nm SFPs.
As the OSC operates at either 1510 nm or 1310 nm, it does not interfere with optical channels operating in
the 1550 nm range (C band). In addition, since the smart optical layer is fully integrated with the OTN layer,
GCC management channels can also be used when available.

Plug and Play

The STMS Plug & Play feature uses the LightPLAN OM/SM output file to install and configure equipment on
managed NEs (locally or remotely) through automatically-generated CLI commands. Plug & Play
functionality simplifies installation and configuration of the NE and its component shelves, cards, and ports,
as well as the associated fiber link configuration. Network operators can work with the intuitive LightPLAN
planning tool GUI to design and configure their network elements; see Planning tools. Then the actual low-
level configuration commands, necessary to configure each module located in each shelf at each site, are
completed for the operators automatically by STMS, working from the XML export file created for STMS by
LightPLAN.

STMS System Overview and Architecture

Optimized for scalability, reliability, and performance, STMS is a comprehensive EMS providing event
handling, network discovery, and provisioning capabilities with built-in support for service provisioning and
management. The STMS includes:
• The STMS (server-side software): An open-architecture distributed object server that runs on Solaris
OSs. It uses a multithreaded design to support large numbers of devices and clients, perform the
transaction processing required to provision NEs, and integrate with existing DBs and OSS
applications. STMS exchanges information with Apollo NEs via CORBA - or optionally CORBA over
SSL - that provides powerful architectural advantages over SNMP-based systems. These include
increased efficiency through fewer calls, enhanced reliability using TCP, and secure communication
with NEs via SSL.
• An Oracle Database: A third-party relational DB that is the central repository for all persistent STMS
data, including network and device models, Apollo NEs configuration information, historical alarms,
and security-related information.
• The STMS Client: A Java-based GUI from which operators can manage, provision, and monitor NEs
to make sure maximum network stability and eliminate configuration errors. Designed to augment the
traditional CLI, the STMS Client features:
◦ Network Explorer and Customer Explorer views that show interfaces, services, and associated
customers
◦ Configuration Manager
◦ XC manager
◦ Fault management profile manager
◦ PM manager

Ribbon Communications Inc. Proprietary 10

 Introducing STMS

◦ Plug & Play

◦ Fiber Connectivity manager
◦ Layout views of NEs
◦ Cabinet view of each NE with the current card configuration
◦ Alarm panel that shows the various alarms that have occurred and subsequent user
acknowledgments

STMS System Architecture

STMS System Architecture

STMS Managed Objects

STMS maintains a model of the managed network in its DB to provide comprehensive provisioning and
management capabilities. The model consists of a set of managed objects that represent the various
elements comprising the network.
A managed object can represent physical elements (such as a chassis, a line card, or a port) or logical
elements (such as a logical interface or protocol family). It can also represent an abstraction of the network
(such as a subdomain or group), an entity that interacts with the network (such as a customer or subscriber),
or services provided by the network (such as 10/40/100G WDM or OTN services).
STMS uses the model it maintains to track the current state of the network and to perform FCAPS
management tasks.

Northbound API
The NB-API consists of a set of Enterprise JavaBean (EJB) interfaces that represent the main access points
for creating, reading, updating, and deleting objects within the STMS Domain. Java applications can use the
EJB interfaces via Java Remote Method Invocation (RMI).

Ribbon Communications Inc. Proprietary 11

 Introducing STMS

CORBA Stubs
STMS generates CORBA stubs to implement a CORBA interface to Apollo NEs. CORBA provides powerful
architectural advantages over SNMP-based systems, including increased efficiency through reduced calls,
enhanced reliability using TCP/IP, and secure communications via SSL.

GUI Layer
STMS (server-side software) implements a sophisticated GUI layer to support the powerful features and
functions of the Java-based STMS Client (Java 8 only).

Event Manager
Implemented on top of the Java Message Service (JMS), the event manager is responsible for receiving
event messages from Apollo NEs and routing them to subscribed client applications. Messages can pertain
to alarms, device trace events, and state change events.

WebLogic System Services

STMS is designed and implemented as a Java 2 Platform Enterprise Edition-based (J2EE) application. As
such, it provides J2EE services such as state management, transactions, persistence, security, remote
procedure call, messaging, and web services. Adopting the J2EE programming model allows the STMS to be
highly scalable and portable, and to evolve rapidly while maintaining the robustness required of mission-
critical environments.

Database Backup Using RDR

The Remote Data Replicator (RDR) application provides redundancy and protection features for the STMS
and LightSOFT. RDR performs remote data backup (replication) between main stations (currently manage
the network) and mirror stations (store the backup data). The backup data can subsequently be restored
(synchronized) on a mirror station if the main station fails.
STMS also supports Automatic RDR (ARDR), which performs the switch between the main stations and the
mirror stations automatically upon failure. The switch is performed for both the STMS and LightSOFT
simultaneously. After the failure on the main site is resolved, the switch back to the main site must be
performed manually.
See the Remote Data Replicator (RDR) User Manual.

Note
For an STMS backup, the following items are not maintained in the DB and must be stored and
backed up separately on a Network File System (NFS) server that is mounted under the root directory
of the STMS server:
• Historical counters
• Software builds
If the NFS server is mounted at the same point in the file system, the standby STMS can open
these items.

Ribbon Communications Inc. Proprietary 12

 STMS Server and STMS Client Startup

STMS Server and STMS Client Startup

This section explains how to start the STMS server and the STMS client, and includes the following topics:
• STMS Server
• SSH Connections Option
• Start and Log in to the STMS Client

STMS Server
This section explains how to start the STMS server, including the following topics:
• Start the STMS Server as a Daemon
• Start the STMS Server Not as a Daemon
• Start the STMS Server as an STMS User

Start the STMS Server as a Daemon

If you select to install the STMS server as a daemon, it is defined to start as a daemon automatically when
the system starts. However, there might be instances when you must start the STMS server manually.

Note
You can also restart the STMS server on Solaris systems. This process stops the server and
immediately restarts it.

Start
1. Open a shell prompt.
2. At the prompt, change the working directory to the directory where STMS will be installed.
3. At the root prompt, type one of the following commands:
◦ /etc/init.d/stms start
◦ /etc/init.d/stms restart
4. Press ENTER.
The STMS server starts/restarts as a daemon.

Note
On some systems, the script might be at /etc/rc.d/init.d/stms.

Start the STMS Server Not as a Daemon

If you select not to install the STMS server as a daemon, you must start the STMS server manually.
Start
1. Log in to the target system.
2. Open a shell, and change the working directory to the directory in which you installed the STMS
software.
3. At the prompt, type:
cd bin
4. Press ENTER.
5. At the prompt, type:
nohup./server&
6. Press ENTER.
The STMS server starts.

Ribbon Communications Inc. Proprietary 13

 STMS Server and STMS Client Startup

Start the STMS Server as an STMS User

Note
The below procedure is applicable for both Solaris and Linux STMS servers.

Start
1. Open a shell prompt.
2. At the prompt, change the working directory to the directory where STMS will be installed.
3. At the root prompt, type:
/opt/STMS/sh/STMS start
4. Press ENTER.
The STMS server starts.

Notes
◦ To check the status of the STMS server, type: /opt/STMS/sh/STMS stat
◦ To stop the STMS server, type: /opt/STMS/sh/STMS stop

SSH Connections Option

As a convenience, you can right-click an NE and select connection to it via SSH.
Linux installations normally contain the appropriate programs needed on the path.
In Windows or Solaris, perform the following steps before running the GUI client:
• Set Up SSH in Windows
• Set Up SSH in Solaris

Set Up SSH in Windows

Windows does not come with a built-in SSH command, so it is necessary to install a third party SSH
application.
The suggested application is PuTTY (can be obtained at http://www.putty.org/).

Note
The default installation location for PuTTY is C:\\Program Files\\PuTTY.
If you want to install PuTTY in a different folder, adjust the instructions in the procedure.

Start
1. Download PuTTY from the internet site.
2. Add C:\\Program Files\\PuTTY to your windows path variable by doing the following:
◦ Go to the Control panel and click System.
◦ Click the Advanced tab and then click the Environment Variables button at the bottom of this
tab.
◦ In System Variables list, select the Path variable, and click Edit.
◦ Add ;C:\\Program Files\\PuTTY to the end of the Path variable.
◦ Click OK.
3. In the directory C:\\Program Files\\PuTTY , copy the binary file putty.exe to a file called ssh.exe.

Ribbon Communications Inc. Proprietary 14

 STMS Server and STMS Client Startup

Set Up SSH in Solaris

By default, SSH is installed in Solaris.
However, in addition to needing SSH, STMS also needs xterm, which, on Solaris installations, is not normally
on the path.
Its usual location is /usr/openwin/bin/xterm.
Start
1. Verify that xterm is in /usr/openwin/bin or locate the xterm binary in your system.
2. Add /usr/openwin/bin to your path.

Start and Log in to the STMS Client

Note
The following procedure is the same for both Linux and Solaris STMS servers.

Prerequisites
• Windows 10 must be installed
• Java 8 Update 321 or 341 must be installed
• User should have admin rights on the Windows machine
Start
1. Add the STMS IP and STMS host name in the Windows 10 PC hosts file at C:
\Windows\System32\drivers\etc.
Example: Here, STMS IP is 172.24.127.204 and the host name is lab-stms-vm4 so the following
entry should be added in the hosts file: 172.24.127.204 lab-stms-vm4

Ribbon Communications Inc. Proprietary 15

 STMS Server and STMS Client Startup

2. Open the web browser, and access https://hostname:7002/.

3. Download emsclient.jnlp and stms_launcher.bat.
4. Click Download and Launch STMS Client via Webstart Launcher.

The Launcher is downloaded.

5. Edit stms_launcher.bat, and add either of the following Java file locations (depending on which
version of Java is installed): C:\Program Files\Java\jre1.8.0_321 or C:\Program
Files\Java\jre1.8.0_341

Ribbon Communications Inc. Proprietary 16

 STMS Server and STMS Client Startup

Note
If Java 1.8.0_341 is installed, the path should be edited accordingly.

6. Access the STMS Downloads web page at http://hostname:7001 or https://hostname:7002 (where

hostname is the host name or IP address of the STMS server).
To access the STMS Downloads web page, the STMS server must be running.
7. Click Launch STMS Client Now.
The jnlp file is downloaded.

Ribbon Communications Inc. Proprietary 17

 STMS Server and STMS Client Startup

8. In the Security tab of the Java Control Panel window, add the server URL (e.g. https://
hostname:7002/) to the Exception Site List.

9. Verify that the Launcher and jnlp file are in the same folder.
10. Open the Launcher.
The Security Warning window opens.

Ribbon Communications Inc. Proprietary 18

 STMS Server and STMS Client Startup

11. Select I accept the risk and want to run the application, and click Run.
The Login window appears.
12. In the User Name field, type your STMS user name.
13. In the Password field, type your password, and click OK.

Note
• If your password has expired or if the system administrator has reset your password since
your last login, you might be prompted to change your password.
• If you don't type a correct password during login, your account might be locked for a period
of time. Contact your system administrator.

The STMS Client main window opens.

Ribbon Communications Inc. Proprietary 19

 STMS Client Settings

STMS Client Settings

You can define the following STMS client preferences and settings:
• Define View Preferences
• Alarm Preferences
• Connection Options
• Define Filtering Preferences
• Manage Licenses

Define View Preferences

Certain items are displayed by the STMS Client as default preferences.
Start
1. From the main menu, select Edit > User Preferences.
The Preferences window opens.

2. In the View tab, define the relevant view settings. For details, see the table below.
3. Click Apply.

Ribbon Communications Inc. Proprietary 20

 STMS Client Settings

View Preferences

Preference Description

STMS Font Options

STMS Font Size Select the font size to use for system text.

STMS Font Style Select the font to use for system text.

STMS Time Format

STMS Time Format Select the time format to be used in the application, either
24-hour or 12-hour (AM/PM).

General Interface Options

Enable "Are You Sure" prompts for By default, you are prompted to confirm any actions that
service-affecting actions might disrupt services.

Use native interface-naming scheme Select to use default naming conventions for cards, ports,
and paths. Clear to use description naming.

Load nested QoS state on startup Select to load only shallow state for Layer 3 classifiers on
GUI startup.

Chassis View

OPT9932 View Select the default view of the OPT9932 chassis:

• Vertical Scroll (Full Scale)
• Zoom In/Out (to/from Reduced Scale)
See OPT9932 Chassis view.

Wavelength Allocation View

Flex Grid View By default, wavelengths are defined using a fixed grid in
which the wavelength values are fixed. Select this checkbox
to enable Flex Grid, which enables defining wavelengths
using flexible values.
For details on using Flex Grid, see the STMS User Guide.

Layout view

Enable Layout View Select to enable/disable the layout view option. The layout
view displays a logical representation of all managed NEs in
the STMS Domain.

Ribbon Communications Inc. Proprietary 21

 STMS Client Settings

Preference Description

Background Image Sets the background image for the layout view option.

Max. NEs in view Sets the maximum number of NEs that can be displayed in
the layout view (default 50).

Properties

Show properties in popup window by By default, right-click an object (NE, component card,
default interface, etc.) and then click Properties to display the
properties for that object in the Property Inspector in the
View panel.
If you select this checkbox, right-click an object and then
click Properties to open the property sheet in a popup
window.

Temperature Units Select the units in which to view temperature statistics:

Degrees Celsius or Fahrenheit

Logging

Show logs from all NEs in a single area By default, the STMS Client displays messages about
system events and conditions for all NEs (for which you have
enabled logging) in one tab in the Alarm/Log panel. If you
clear this checkbox, messages about system events and
conditions for each NE type (for which you have enabled
logging) are displayed in separate tabs in the Alarm/Log
panel.

Alarm Preferences
This section explains how to define alarm preferences. You can define preferences for alarm views and
alarm notifications.
The STMS Client can be defined to notify users via email or audible or not audible alarm of specific alarms
received from an NE managed by the STMS Client. Email notifications, which contain a summary of the
alarm, can be sent to other systems such as SMS or paging, which can then forward the information to a
user. In the event that the STMS Client is unsuccessful in sending a notification email, the STMS Client
writes the notification to a log. Audible notifications play a WAV file when a specified alarm condition is met.
The sound is played for all the clients specifically defined for that alarm condition.
• Set the Alarm View Preferences in the STMS
• Set the Audio Notification Preferences in the STMS
• Add an Alarm Notification in the STMS
• Edit an Alarm Notification in the STMS
• Delete an Alarm Notification in the STMS
• Reorder Alarm Notifications in the STMS
• Enable Audible Alarm Notifications in the STMS
• Pause Alarm Notifications in the STMS

Ribbon Communications Inc. Proprietary 22

 STMS Client Settings

Set the Alarm View Preferences in the STMS

Start
1. From the Edit menu select User Preferences.
The Preferences window opens.
2. In the Alarms tab, under General, select or clear the Use hierarchical view for default alarm view
checkbox.

Note
By default, alarms are displayed in table view and this checkbox is cleared.

3. Click Apply.
A message popup states that the STMS Client must be restarted for your change to take effect.

Set the Audio Notification Preferences in the STMS

By default, alarms are displayed in the STMS Client with no audible alert.
Start
1. From the Edit menu select User Preferences.
The Preferences window opens.
2. In the Alarms tab, under Audio, select or clear the Enable audio notification for alarms checkbox.
3. Click Apply.

Add an Alarm Notification in the STMS

Start
1. From the Edit menu select User Preferences.
The Preferences window opens.
2. In the Alarms tab, click the Add button.
The Notifications window opens.

Ribbon Communications Inc. Proprietary 23

 STMS Client Settings

3. In the Criteria Name field, type a name for the notification.

4. Select one of the following:
◦ To indicate that the alarm notification should be processed when all of the specified criteria are
met, click Match all of the following.
◦ To indicate that the alarm notification should be processed when any of the specified criteria is
met, click Match any of the following.
5. From the first dropdown list, select an alarm criteria.
6. From the second dropdown list, select a boolean operator.
7. From the third dropdown list, select the alarm condition that triggers the notification.
8. To add additional alarm conditions, click More. Click Less to delete alarm conditions, beginning with
the last one shown.
9. To open the optional advanced notification settings, click Advanced and enter the following:
◦ In the Frequency field, type the number of times that the alarm condition must occur before the
notification is processed. Note that all of the criteria you type must be matched every time for the
alarm condition to be counted.
◦ In the Period field, type the number of milliseconds that must pass before the alarm notification is
reprocessed.
◦ Select the Terminate box to indicate that subsequent alarm notifications should not be processed
after this alarm notification.
10. To define the alarm notification as an email:
◦ Click Send Email, then click Configure. The Configure E-mail window opens.
◦ Type the information you wish to email. The required fields are From, To, Subject, and Message.
◦ (Optional) You can use alarm variables in the Message field using the format ${variable_name}.
The alarm variables display the corresponding information within the message text. See Email
Alarm Variables.
◦ Click Finish.
To enable email notifications, you must also define SMTP server settings for the STMS server. See
the STMS User Guide
11. To define the alarm notification as an audible alert:
◦ Click Play Sound and then click Choose.

Ribbon Communications Inc. Proprietary 24

 STMS Client Settings

◦ Select a WAV file, and click Open.

12. Click Finish.

Edit an Alarm Notification in the STMS

Start
1. From the Edit menu select User Preferences.
The Preferences window opens.
2. In the Alarms tab, select the alarm you wish to edit.
3. Click the Edit button.
The Notifications window opens.

4. For specific details on alarm notifications, see Add an Alarm Notification in the STMS.
5. After completing the edits, click Finish.

Delete an Alarm Notification in the STMS

Start
1. From the Edit menu, click User Preferences.
The Preferences window opens.
2. In the Alarms tab, select the alarm you wish to delete.
3. Click Remove.

Ribbon Communications Inc. Proprietary 25

 STMS Client Settings

Reorder Alarm Notifications in the STMS

The order of the alarm notifications affects how these notifications are processed. If the Terminate checkbox
is selected for a specific notification, subsequent alarm notifications are not processed, provided that the
preceding notification's alarm criteria were met.
Start
1. From the Edit menu select User Preferences.
The Preferences window opens.
2. In the Alarms tab, select the alarm you wish to move.
3. Click the Move Up or Move Down buttons to reposition the alarm notification.

Enable Audible Alarm Notifications in the STMS

Start
1. From the Edit menu select User Preferences.
The Preferences window opens.
2. In the Alarms tab, click/clear the Enable audio notification for alarms checkbox to enable/disable
audible alarms.

Pause Alarm Notifications in the STMS

When you pause an alarm notification, audible alarms are not processed and email is not sent when the
specified alarm conditions are met.
Start
1. From the Edit menu select User Preferences.
The Preferences window opens.
2. In the Alarms tab, in the Enabled column, clear the Enabled checkbox for the notification you wish to
be paused. To resume the notification, select the Enabled checkbox.

Connection Options
At a specified interval, the STMS Client pings the STMS server (the one it is defined to communicate with) to
determine the status of communication. If a specified number of ping failures occurs, the STMS Client sets
the status of communication with the STMS server as "Not Connected." The STMS Client continues to ping
the STMS server until communication is reestablished.
You can:
• Change the Ping Interval
• Set the Number of Ping Failures

Change the Ping Interval

Start
1. From the Edit menu select User Preferences.
The Preferences window opens.
2. In the Connection Options tab, in the Ping Interval field, type the number of seconds between ping
attempts.
3. Click Apply.

Set the Number of Ping Failures

Start
1. From the Edit menu select User Preferences.

Ribbon Communications Inc. Proprietary 26

 STMS Client Settings

2. The Preferences window opens.

3. In the Connection Options tab, in the Ping Failures field, type the number of ping failures that occur
before the STMS Client sets the status of communication with the STMS server as "Not Connected."
4. Click Apply.

Define Filtering Preferences

The STMS Client uses default preferences to limit the number of NEs displayed in the STMS Client at a
given time.
By default, if the number of NEs displayed for a customer exceeds the specified maximum value, you receive
a warning message indicating that not all the objects are displayed. You can define the STMS Client to
automatically prompt you with a filtering window when the number of displayed NEs exceeds a specific
threshold. You can also define the maximum number of NEs to be displayed for a customer.
Start
1. From the Edit menu select User Preferences.
The Preferences window opens.
2. Open the Filtering tab.

3. Select the Enable automatic filter prompt checkbox.

4. In the Auto filter prompt threshold field, type the number of NEs to be displayed before you are
prompted with the filtering window (default 1000).
5. In the Max. network elements per domain field, type the maximum number of NEs to be displayed
for a customer (default 8000).

Ribbon Communications Inc. Proprietary 27

 STMS Client Settings

6. Click Apply.
A message appears stating that the STMS Client must be restarted for your changes to take effect.
7. Click Yes to restart the STMS Client.
The STMS Client closes and then restarts. The filtering preferences are updated.

Manage Licenses
Some STMS features are only available if the relevant license has been purchased (and the license has not
exceeded its limits or expiration date).
The following licenses are available:

Ribbon Communications Inc. Proprietary 28

 STMS Client Settings

Description of License Types

License Type Rates Tokens Details

Required

ASON Enables ASON ports.

2.5G 1

10G 1

40G 4

100G 10

200G 20

WSON Enables WSON trails. For 1++

protection of such a WSON trail,
STMS detects 2 separate
WSON trails, so the charge is
double.
The tokens are charged for
each trail (double charge for a
usual trail, which is always
1+R).

≤10G 1 OTU1, OTU2, OTU2e,

STM1/1e/4/16/64, OC3/3e/
12/48, FC400, FC800, FC1200,
GBE, 10GBE

16G 2 FC1600

25G 3 25GBE

32G 3 FC3200

40G 4 OTU3, OTU3e, 40GBE

100G 10 OTU4, FLEXO-1, 100GBE

200G 20 OTUC2, FLEXO-2

300G 30 FLEXO-3

Ribbon Communications Inc. Proprietary 29

 STMS Client Settings

License Type Rates Tokens Details

Required

400G 40 OTUC4, FLEXO-4, 400GBE

400G 40 ENHZR-400

500G 50 ENHZR-500

600G 60 ENHZR-600

700G 70 ENHZR-700

800G 80 ENHZR-800

900G 90 ENHZR-900

1000G 1000 ENHZR-1000

1100G 1100 ENHZR-1100

1200G 1200 ENHZR-1200

Client 1G-64G Enables 1G-64G client ports for

Tokens the CMR100, CMR100M,
CMR200, CMR400, MIO200,
MIO200B, MIO200BEN, TM200,
TM200EN, TM200ENB,
TM200B, TM100_2EN,
TM100_2ENB, TM400ENB,
TM400ENB_M, TM400R, and
TM400R_M cards.

1G-10G 1

FC1200 and FC1600 1

25G 3

FC3200 3

40G 4

FC6400 6

Ribbon Communications Inc. Proprietary 30

 STMS Client Settings

License Type Rates Tokens Details

Required

Client 100G Tokens 100G 1 Enables 100G client ports for

the MIO200EN, MIO200I,
TM200EN, TM100_2EN,
TM100_2ENB, TM200ENB,
TM200B, TM800, TM1200, and
TR200_2 cards.

Client 100G Tokens This license is required to

for NG 400G Cards unlock 100G ports on the
following supported cards:
TM400_2, TM400ENB, CMR400

Client 400G Tokens 400G 1 Enables 400G client ports for

the TM800E and
TM1200E cards.

Client 400G Tokens 400G This license is required to

for NG 400G Cards unlock 400G ports on the
following supported cards:
TM400_2, TM400_MC,
TM400ENB

Client 25G Tokens 25G This license is required to

for TM400_2 unlock 25G ports on the
following supported cards:
TM400_2 and TM400_MC

OPT9901x 100G Line 100G 1 Enables 100G line ports for the
Port Tokens OPT9901x card.

NBI Connections Enables the STMS CORBA NBI

towards upper-level
management systems
(LightSOFT or OSS). When the
EMS is integrated under
LightSOFT, one such license is
required.

Network Element These licenses dictate how

Tokens many NEs the EMS can
manage (within sizing rule
limits). These tokens may be
ordered individually or as a bank
of 6.

OPT9603 1

Ribbon Communications Inc. Proprietary 31

 STMS Client Settings

License Type Rates Tokens Details

Required

OPT9608 and 2
OPT9608D

OPT9901X 3

RADM100 6 (2 OPT9901X
NEs)

OPT9624 6

OPT9904X 6

OPT9914 10

OPT9932 20

Advanced MPLS Enables MPLS-PE Switching

Tokens Mode on AoC10_L2 cards.
1 token is charged each time
the Switching Mode of an
AoC10_L2 is changed to MPLS-
PE.

Encryption Tokens Enables the following cards:

TR10_4EN, TM200_EN,
TM200_ENB, TM100_2EN,
TM100_2ENB, TR10_12EN,
TR10_12ENB, HIO500EN,
MIO200EN, MIO200BEN,
TM400ENB, TM400ENB_M,
TM400ENB_T

1G-10G 1

32FC (FC3200) 3

40G 4

100G 10

8FC (FC800) 1

16FC (FC1600) 1

Ribbon Communications Inc. Proprietary 32

 STMS Client Settings

License Type Rates Tokens Details

Required

300G 30

400G 40

Line Encryption Enables encryption on the

Tokens HIO400EN, MIO200EN, and
MIO200BEN cards.
1 token is charged for each line
port configured with encryption
enabled.

Line Mode Tokens Enables line ports for the

TM1200, TM800, TM1200E, and
TM800E cards.
Metro tokens can also be used
to unlock DCI applications. In
addition, LH can be used to
unlock both the DCI and the
Metro.

DCI Line Mode 450Gbps – 600Gbps

Tokens

Metro Line Mode 250Gbps – 600Gbps

Tokens

Long-Haul Line Mode 50Gbps – 600Gbps

Tokens

DCO Line Port Enables DCO transceivers for

Tokens metro and long-haul
applications.
Long-Haul tokens enable
unlocking of both Long-Haul and
Metro lines. If Metro line tokens
are not available on STMS,
Long-Haul tokens are used for
Metro lines.

Metro Line Tokens 300Gbps, 400Gbps, OTR400P2_CF26,

FlexO-3, FlexO-4 OTR400P2_CFA2T,
OTR400P2_CFA2,
OTR400P2_CFA1

Ribbon Communications Inc. Proprietary 33

 STMS Client Settings

License Type Rates Tokens Details

Required

Long-Haul Line 200Gbps, FlexO-2 OTR200P2_CFA2,

Tokens OTR200P2_CFA2BD,
OTR400P2_CF26,
OTR400P2_CFA2T,
OTR400P2_CFA2,
OTR400P2_CFA1

12.5Ghz Alien Tokens are charged according

Spectrum Tokens to the bandwidth connected to
the OCHP port, where each
token supports 12.5G
bandwidth.

Alien channel connected 4

to 50G BW channel in
ROADM

Alien channel connected 5

to 62.5 BW channel in
ROADM

Alien channel connected 6

to 75.0 BW channel in
ROADM

Alien channel connected 7

to 87.5 BW channel in
ROADM

Alien channel connected 8

to 100G BW channel in
ROADM

TM400 2nd Line Port 1 Enables the support of the

Tokens TM400 card.
The first line port is not charged
(regardless of whether it's line 0
or line 1). 1 token is charged for
the second line port. TM400-
REG100 ports do not require a
license.

TM400 Client Tokens This license enables 1 x 100G

client port on the TM400 card.
The first one is unlocked. You
need 3 more licenses to unlock
a full TM400.

Ribbon Communications Inc. Proprietary 34

 STMS Client Settings

License Type Rates Tokens Details

Required

TM800_2 Client 100G client tokens Consumes 1 token per 100G in

Tokens each client port

400G client tokens Consumes 1 token per 400G in

each client port

TM800_2 Line Port 500-800G metro token Applies to transceivers

Tokens for OTR800PJxx OTR1200PJ_CF and
OTR800PJxx, counted based
on line port configured bit rate of
500-800 Gbps

400G long haul token for Applies to transceivers

OTR800PJxx OTR1200PJ_CF and
OTR800PJxx, counted based
on line port configured bit rate of
400Gbps

OPT9914/32 Matrix Charged for the OPT9914/32

Capacity 10G cards used.
Tokens

TIOMR_32 3

HIO10_20 20

HIO100_2 20

HIO10_40 40

HIO400 (HIO500) and 40

HIO400A

OPT9914/32 Port Charged for the OPT99xx ports

Capacity 10G assigned for HIO10_20,
Tokens HIO100_2, or MIO700 cards.
The ports assigned for the
TIOMR_32 card are free.

10G 1

40G 4

100G 10

Ribbon Communications Inc. Proprietary 35

 STMS Client Settings

License Type Rates Tokens Details

Required

200G 20

300G 30

400G 40

OPT99xx Enable 1 Charged for the GExx ports

Packet Tokens assigned for HIO10_20,
HIO100_2, HIO400, or MIO200
cards.

Alien Pluggable Charged for third-party

Tokens pluggables based on the port's
rate.

1G-10G 1

32FC 3

40G 4

100G 10

You can view and manage your licenses and the available tokens via the License Manager.
To manage licenses:
1. From the System menu, select License Manager.
The STMS License Manager window opens.

Ribbon Communications Inc. Proprietary 36

 STMS Client Settings

2. To change the Expiration Date format, select the format from the dropdown list.
3. Click one of the following buttons:
◦ License String: Displays the license string and enables copying it.
◦ Description: Enabled when an entry in the list is selected. It describes the number of tokens
charged by STMS for the selected feature.
◦ Not Usable List: Shows a list of the objects that are "not usable" due to license "overdraft". "Not
usable" for ports means that they can't be used in trails.
◦ Load License: Enables loading a license file to replace the current one, to extend the expiration
date or increase the number of tokens.
◦ Save License as: Enables saving the license to a specific location.

Ribbon Communications Inc. Proprietary 37

 The STMS Client

The STMS Client

The STMS client enables you to manage, provision, define, and monitor your network as follows:
• The Explorer Pane
• View Options
• View the Alarm and Log Panel
• Exit and Shut Down the STMS

The Explorer Pane

The Explorer pane provides tree views of NEs, component cards, interfaces, services, and customers.
Explorer pane

The Explorer area contains the following tabs:

• Network Explorer: Displays a representation of your network in the form of a tree hierarchy.
Cards and modules assigned to each NE appear in the following slot groups below the NE:
◦ Common Slots
◦ IO Slots
• Customer Explorer: Displays all of the logical interfaces and services that have been defined in your
network, organized according to the customer to which they are assigned.
The following icons might appear next to network objects in the Explorer area when relevant:

Ribbon Communications Inc. Proprietary 38

 The STMS Client

• - Indicates that a maintenance operation is running on the object.

• - Indicates that an alarm exists for the object.

You can perform various configuration and management tasks by right-clicking on objects in the Explorer
area. For more information, see the STMS User Guide.

View Options
STMS provides a collection of detailed views for examining your network:
• Network Element Status View
• Network Element Layout View
• Chassis View
• Properties View

Network Element Status View

The Network Element Status view displays information for each NE, including host name, type, state, group,
when the element was initially discovered, and any reason that discovery might have failed. This is the
default view for the Network Explorer.
To view the Network Element Status view for the entire network:
• From the Network Explorer, right-click STMS Domain and select Network Element Status.
The NEs and their details appear in the right area.

To view the Network Element Status view for a specific NE:

• From the Network Explorer, right-click the NE and select Element Status.
The elements for the selected NE and their details appear in the right area.

Ribbon Communications Inc. Proprietary 39

 The STMS Client

The Network Element Status view displays information for each NE, including host name, type, state, group,
when the element was initially discovered, and any reason that discovery might have failed. This is the
default view for the Network Explorer.
To view the Network Element Status view for the entire network:
• From the Network Explorer, right-click STMS Domain and select Network Element Status.
The NEs and their details appear in the right area.

To view the Network Element Status view for a specific NE:

• From the Network Explorer, right-click the NE and select Element Status.
The elements for the selected NE and their details appear in the right area.

Ribbon Communications Inc. Proprietary 40

 The STMS Client

Network Element Layout View

The Network Element Layout view displays a logical representation of all managed NEs in the STMS
Domain. This view also shows the services defined between NEs, when applicable.
To open Layout view, you must first enable it in the User Preferences settings.
To enable the NE Layout view:
1. From the main menu, select Edit > User Preferences.
The Preferences window opens.

Ribbon Communications Inc. Proprietary 41

 The STMS Client

2. In the View tab, select the Enable Layout View checkbox.

3. (Optional) Select the image you wish to use as the background image, and click Upload.
4. In the Max. NEs in view field, type the maximum number of NEs to be displayed in the layout view.
5. Click Apply.
The changes take effect when the GUI is restarted.
To view the NE Layout view:
• On the main toolbar, select View > Network Element Layout.
The NE Layout view appears.

Chassis View
The Chassis view displays a graphical representation of a specific NE, including views of the card cages and
a card inventory table. You can display the Chassis view in the right pane or in a new window.
Start
1. In the Network Explorer tab, right-click the NE and select one of the following:
◦ Show Chassis: Displays the Chassis view in the right pane.
◦ Show Chassis in New Window: Displays the Chassis view in a new window. You can perform
configuration operations for only the specific NE from the Chassis view window.
The NE Chassis view appears. The Chassis view for OPT9932 has additional view options (see
OPT9932 Chassis view).

Ribbon Communications Inc. Proprietary 42

 The STMS Client

The following icons can appear next to the NE name, when relevant:

◦ - Indicates that a maintenance operation is running on the NE

◦ - Indicates that an alarm exists for the NE (color changes according to the alarm severity)
2. The default Chassis view displays a graphical representation of the configured cards. To see the
actual installed cards in the chassis, select the Show Actual option.

Ribbon Communications Inc. Proprietary 43

 The STMS Client

Note
You can perform various configuration and management tasks via the menus, and by right-
clicking on the ports. Most of the Chassis view menu options are also available from the right-
click menus in the Explorer area and from the STMS main menus.

Refer also to:

◦ Change the OPT9932 Chassis View
◦ Port Status Indications

Change the OPT9932 Chassis View

As the OPT9932 chassis is too large to view in the regular Chassis view without scrolling, you can change
the chassis view to a smaller view.
Start
1. From the OPT9932 Chassis view, click Change OPT9932 View.
The chassis view appears in a reduced format (left) next to the expanded format of the top/bottom
area of the chassis (right). The card/port menus are only available in the expanded format.

2. To view the expanded top or bottom area of the chassis, click Top Expand or Bottom Expand.
3. To change back to the regular Chassis view, click Change OPT9932 View.

Port Status Indications

The status of the ports on component cards is indicated visually in the Chassis view.

Ribbon Communications Inc. Proprietary 44

 The STMS Client

Port Status Indication

Port Appearance Description

Port has not been configured.

SFP Port Configured

Simple Connector Port Configured

XFP Port Configured

Note
To indicate an alarm condition, the port color changes to yellow, orange, or red.

Properties View
The Properties view displays detailed information about objects in the network.

Note
The screenshots below show examples of the NE Properties view.

Start
1. In the Network Explorer tab, right-click the NE and select Properties.
2. Click General.
The General tab appears in the right pane.

Ribbon Communications Inc. Proprietary 45

 The STMS Client

3. Click Shelf & Time.

The Shelf & Time tab appears in the right pane.

4. Click Location.
The Location tab appears in the right pane.

Ribbon Communications Inc. Proprietary 46

 The STMS Client

5. Click IP & Firewall.

The IP & Firewall tab appears in the right pane.

6. Click PM.
The PM tab appears in the right pane.

Ribbon Communications Inc. Proprietary 47

 The STMS Client

7. Click OTDR.
The OTDR tab appears in the right pane.

View the Alarm and Log Panel

The Alarm/Log panel displays network alarm notifications and STMS audit and error messages. It is in the
lower panel of the STMS Client window.
The Alarm/Log panel consists of the following tabs:
• Alarms: Displays notifications about exceptions within the network, such as traffic signal degrading or
equipment malfunctioning.
• Historical Alarms: This tab appears if you enable maintaining of historical alarms. You can view a
history of alarms for a specified period of time.
• Server Audit Log: Displays messages about the STMS that indicate the occurrence of non-error
system events or conditions, such as user login.

Ribbon Communications Inc. Proprietary 48

 The STMS Client

• GUI Audit Log: Displays messages about the STMS Client that indicate the occurrence of non-error
system events or conditions, such as NEs being discovered.
• GUI Error Log: Displays messages about the STMS Client that indicate the occurrence of system
exceptions or conditions.
• Network Element Logging: If you enable logging for one or multiple NEs, this tab appears in the
Alarm/Log panel and displays messages about NE system events or conditions.

Note
For information about viewing and managing alarms, see Fault management. For information
about logging and tracing, see Log management.

Refer also to:

• Alarm Colors and Indications
• STMS Status Bar

Alarm Colors and Indications

Alarm conditions are visually reflected in the STMS Client window.

Alarm Colors and Indicators

Severity Color Description

Minor Yellow Problem conditions that don't have a serious effect on

service to customers or are not essential to NE
operations.

Major Orange Serious disruption of service or the malfunctioning/failure

of important components/functions.

Critical Red Severe service-affecting condition - immediate corrective

action is imperative.

Note
Alarm indicators appear in the lower right portion of an object icon in the Explorer panel and Layout
views, for example, .

If an NE is in a state which prevents the STMS from managing it, an indicator ( ) appears in the
lower portion of the NE icon to indicate that management is disabled.

STMS Status Bar

The STMS Status bar is in the lower portion of the STMS Client window.

The STMS Status bar provides the following information:

• Alarm counts: Number of active Minor, Major, and Critical alarms.
• STMS Client status: Current status of the STMS Client.
• STMS server connection status: Status of the connection between the STMS Client and the STMS
server.

Ribbon Communications Inc. Proprietary 49

 The STMS Client

Exit and Shut Down the STMS

Note
To make sure a proper and orderly shutdown of the STMS server, carefully follow the procedures
outlined in this section. Do not attempt to shut down the STMS server by closing the associated
command prompt window or by breaking out of the process (e.g., Ctrl-C), as such actions can
adversely impact STMS performance.

To exit the STMS Client:

• On the File menu, click Exit.
To shut down the STMS server on a Solaris system:
1. Open a shell prompt.
2. At the prompt, go the directory where STMS is installed.
3. At the prompt, go to the bin directory.
4. At the prompt, type ./admin -shutdown.
5. Press ENTER.

Ribbon Communications Inc. Proprietary 50

 Users and Security

Users and Security

The STMS applies access control to prevent unauthorized access to the STMS Client, and to control the
specific STMS functions each user is authorized to access. To use the STMS Client, you must log in with a
valid STMS user account. The tasks and functions you can perform using the STMS Client depend on the
user group to which you have been added.
• STMS User Groups
• View Defined Users
• Define Password Requirements
• Create a User
• Edit a User
• Delete a User
• Reset a User's Password
• Change the User Group for a User
• View Active User Sessions
• End a User Session
• View Audit Events
• Activity Logs
• Archive of Activity Logs, Events, and Alarms
• Backup and Restore on Linux

STMS User Groups

In STMS, permissions and user rights are defined for user groups. When you add a user to a user group, you
grant the user all the permissions defined for that group. STMS includes the following predefined user
groups:

Ribbon Communications Inc. Proprietary 51

 Users and Security

STMS User Groups

User Group Description

Administrator Perform all operations.

Security Perform all security and monitoring operations, but not

acknowledge alarms.

Configuration • Perform all topology configuration, traffic configuration, fault

management, and maintenance operations.
• Perform limited security operations, including viewing user
security settings, changing their own password, and viewing
active users.
• Access security operations not listed above as read-only.

Provisioning • Perform all traffic configuration, fault management, and

maintenance operations.
• Perform limited security operations, including viewing user
security settings, changing their own password, and viewing
active users.
• Access topology operations and security operations not listed
above as read-only.

Maintenance • Perform all maintenance, PM configuration, and fault

management operations.
• Perform limited security operations, including viewing user
security settings, changing their own password, and viewing
active users.
• Access topology operations, traffic configuration, and security
operations not listed above as read-only.

Observer Access all options as read-only, except:

• Change their own password (security)
• Alarm and log filters (fault management)

Level 1 Currently has the same capabilities as Observer. Will be

customizable in future releases.

Level 2 Currently has the same capabilities as Observer. Will be

customizable in future releases.

View Defined Users

Start
• From the Security menu, select Security Configuration.
The Security Configuration window opens, displaying the list of defined users.

Ribbon Communications Inc. Proprietary 52

 Users and Security

Note
The Security Configuration window is only available to users defined with Administrator or
Security user group privileges.

You can enable or disable a user account by selecting or de-selecting the checkbox in the Enabled
column. When a user account is disabled, the user can't log in to the STMS client.

Define Password Requirements

Start
1. From the Security menu, select Security Configuration.
The Security Configuration window opens.

Ribbon Communications Inc. Proprietary 53

 Users and Security

Note
The Security Configuration window is only available to users defined with Administrator or
Security user group privileges.

2. Define the password settings, as required:

◦ Min. Password Length: The minimum number of characters that the password can have.
◦ Unsuccessful Logins Before Lockout: The number of times a user can type an incorrect
password before the user is locked out.
◦ Unsuccessful Login Interval (min.): The time period in which the unsuccessful login attempts
performed by the user will lead to lockout. For example, you can define that if three unsuccessful
login attempts are performed within a 10-minute period, the user is locked out.
◦ Lockout Period (min.): The time period a user is locked out (if lockout occurs). During this period,
the user can't log in, even with the correct password. After this period, the user can attempt
another login.
◦ Password Duration (months): The time period that the password will be valid before it expires.
When a user's password expires, the user is prompted to create password during the next login
attempt.
◦ Upper Case Required: Defines that the password must include at least one uppercase letter.
◦ Lower Case Required: Defines that the password must include at least one lowercase letter.
◦ Digit Required: Defines that the password must include at least one digit.
◦ Password-Username-Policy Required: Allowed Substring Length (default value is 4 and the
valid range is 4 to 8 characters). This means that a substring of maximum 4 (or 5,6,7,8) characters
from the username can appear in the password.
◦ Password History Enabled: Enables saving a defined number of previous passwords, so that a
new password defined by the user can't be the same as any of the previous passwords. The
number of saved passwords must be defined in the Size field.
3. Click Apply.
The password requirements are saved.

Ribbon Communications Inc. Proprietary 54

 Users and Security

Note
An example of the Password-Username-Policy Required requirement:
When creating a user whose username is johnsmith and the Allowed Substring Length is set to 4.
The password can be something like joh$$$$$ or john$$$$ but it cannot be johns$$$ because the
substring "johns" exceeds the allowed substring length.

Create a User
Start
1. From the Security menu, select Security Configuration.
The Security Configuration window opens.

Note
The Security Configuration window is only available to users defined with Administrator or
Security user group privileges.

2. Click Create User.

The Create User window opens.

Ribbon Communications Inc. Proprietary 55

 Users and Security

3. In the User Name field, type a name for the user.

4. In the Password field, type a password for the user.
5. In the Verify Password field, type the password again.
6. From the User Group dropdown list, select the user group for the new user. For details, see STMS
user groups.
7. If you want the user to change their password when logging in for the first time, select Change
password at login.
8. (Optional) Click the User Info tab.
The user information fields appear.

Ribbon Communications Inc. Proprietary 56

 Users and Security

9. Enter the user's details. For the Password Expiration Date, you can enter an expiration date or
select Never for the password to never expire.
10. Click Finish.
The new user is added.

Edit a User
Start
1. From the Security menu, select Security Configuration.
The Security Configuration window opens.

Ribbon Communications Inc. Proprietary 57

 Users and Security

Note
The Security Configuration window is only available to users defined with Administrator or
Security user group privileges.

2. Select the user you want to modify and click Edit User.
The Edit User window opens.

Ribbon Communications Inc. Proprietary 58

 Users and Security

3. Edit the user's details as required.

4. Click Finish.
The user's details are updated.

Delete a User
Start
1. From the Security menu, select Security Configuration.
The Security Configuration window opens.

Ribbon Communications Inc. Proprietary 59

 Users and Security

Note
The Security Configuration window is only available to users defined with Administrator or
Security user group privileges.

2. Select the user you want to delete and click Delete User.
A confirmation message appears.
3. Click Yes.
The user is deleted.

Reset a User's Password

Start
1. From the Security menu, select Security Configuration.
The Security Configuration window opens.

Ribbon Communications Inc. Proprietary 60

 Users and Security

Note
The Security Configuration window is only available to users defined with Administrator or
Security user group privileges.

2. Select the user whose password you want to change and click Reset Password.
The Reset Password window opens.

3. In the New Password field, type a new password for the user.
4. In the Verify New Password field, type the password again and click OK.
The password is reset.

Note
In case the password-username-substring policy is enabled and the STMS user attempts
to change a password, the STMS enforces the password-username-substring policy.
Refer to Define Password Requirements. An example is provided.
The STMS will extract all the substrings from the username, the substring length being
according to the configured Allowed Substring Length (default value is 4 and the valid range
is 4 to 8 characters).
In case one of the substrings appears in the password, it will reject the change password
request.
An error message " Username substring <"detected substring"> found in password" appears.

Ribbon Communications Inc. Proprietary 61

 Users and Security

Change the User Group for a User

Start
1. From the Security menu, select Security Configuration.
The Security Configuration window opens.

Note
The Security Configuration window is only available to users defined with Administrator or
Security user group privileges.

2. Select the user for which you want to change the user group and click Change Group.
The Change Group window appears.

3. Select the user group from the dropdown list and click OK.
The user group is updated for the user.

View Active User Sessions

Start
• From the Security menu, select Active Users.
The Active User Sessions window opens, displaying the list of users currently logged in to the STMS
client.

Ribbon Communications Inc. Proprietary 62

 Users and Security

Note
The Active User Sessions window is only available to users defined with Administrator or
Security user group privileges.

End a User Session

Start
1. From the Security menu, select Active Users.
The Active User Sessions window opens, displaying the list of users currently logged in to the STMS
client.

Ribbon Communications Inc. Proprietary 63

 Users and Security

Note
The Active User Sessions window is only available to users defined with Administrator or
Security user group privileges.

2. Select the user session you want to end and click Force Logout.

Note
The Force Logout button is disabled if you select your own user session.

The user is logged out of the STMS client.

View Audit Events

Start
1. In the Network Explorer tab, right-click STMS Domain and click Properties.
OR
On the Edit menu, click Server Preferences.
2. Select the Audit Events tab.
The Audit Events window opens.

Ribbon Communications Inc. Proprietary 64

 Users and Security

The following table describes the audit events properties.

Audit Events Properties

Field Description

User Username of the user who attempted to log in to the server

Time Time of login attempt

Result Result of login attempt

Activity Logs
The STMS Action Log module records and displays user operations that affect the configuration of the
network or of the STMS.
The STMS presents the log records in the following logs:
• Activity Log: Displays records of every user action that affects the network configuration, according
to the following categories:
◦ Equipment
◦ Services and traffic
◦ Topology
◦ Maintenance
◦ STMS configuration
◦ License management
See View the Activity Log.
• Security Log: Displays records of the following user actions:
◦ Login
◦ Logout
◦ Forced logout
◦ Password change
See View the Security Log.
To archive activity logs, see Archive of Activity Logs, Events, and Alarms.

Ribbon Communications Inc. Proprietary 65

 Users and Security

View the Activity Log

Start
1. From the Security menu, select Activity Log.
The Activity Log window opens, displaying the log records.

Note
You can select the amount of records to be displayed via the Page Size dropdown list.

2. To filter the log records:

◦ Expand the Filter area.
The filter options appear.

◦ Filter the activity logs according to category, operation result, time period, and/or specific text.

Ribbon Communications Inc. Proprietary 66

 Users and Security

◦ Click Apply.
The filtered log records appear.

Notes

• To export the Activity Log to a CSV file, click Export .

• To refresh the Activity Log, click Refresh .

• To print the Activity Log, click Print .

View the Security Log

Start
1. From the Security menu, select Security Log.
The Security Log window opens, displaying the log records.

Note
You can select the amount of records to be displayed via the Page Size dropdown list.

2. To filter the log records:

◦ Expand the Filter area.
The filter options appear.

Ribbon Communications Inc. Proprietary 67

 Users and Security

◦ Filter the activity logs according to category, operation result, time period, and/or specific text.
◦ Click Apply.
The filtered log records appear.

Notes

• To export the Security Log to a CSV file, click Export .

• To refresh the Security Log, click Refresh .

• To print the Security Log, click Print .

Archive of Activity Logs, Events, and Alarms

STMS automatically archives activity logs, events, and alarms according to predefined settings. See Define
Archive Settings.
You can also perform a manual archive, which archives the records immediately, regardless of the archive
settings. See Manually Archive Records.
You can view the archived log records by type, as described in View Archived Log Records.

Define Archive Settings

You can define the archive settings for activity logs, events, and alarms. The records are automatically
archived in XML or CSV format in the STMS database.
Start
1. From the System menu, select Archive Management > Archive Settings.
The Archive Settings window opens.

Ribbon Communications Inc. Proprietary 68

 Users and Security

2. Define the following settings, as required:

◦ Interval Day: The time interval (in days) of the automatic archive process.
◦ Check Time: The time at which the automatic archive process runs.
◦ File Type: The file format used for storing the archived log records: XML or CSV.
◦ Max Log Count: The maximum number of records that can be stored in the STMS database.
When the defined maximum number of records is reached, the records are automatically archived
and deleted from the database. The value can be between 1-50,000 (default is 20,000). You must
define this setting separately for each record type.
3. Click Apply.
The archive settings are saved.

Manually Archive Records

You can manually archive activity log, events, and alarms, regardless of the defined archive settings. The
records are archived immediately.
Start
1. From the System menu, select Archive Management > Archive Immediately.
The Archive Immediately window opens.

2. In the Selected column, select the checkbox of the record type you want to archive immediately.
3. The checkbox in the Clear After Archive column is selected automatically, which enables the deletion
of the records from the STMS database upon completion of the archive process. If you don't want the
records to be deleted, de-select this checkbox for the relevant log type.

Note
The Clear After Archive option is disabled for Current Alarm records.

4. Click Apply.
The log records are archived.

Ribbon Communications Inc. Proprietary 69

 Users and Security

View Archived Records

Start
1. From the System menu, select Archive Management > View Archived Logs.
The Archived Log Files window opens.

2. From the Select Log Type dropdown list, select the log type.
The log files appear.

3. Select the relevant file and click Open.

The log records appear.

Ribbon Communications Inc. Proprietary 70

 Users and Security

Note
You can select the amount of records to be displayed via the Page Size dropdown list.

Backup and Restore on Linux

The script EmsStmsDBBackup enables you to backup and restore the STMS schema.

Prerequisites
1. STMS must be stopped before start a restore (STMS stop).
2. The schema backup is created in the Oracle server zone in the folder /sdh_home/ora/.BACKUP
using a new unique directory name (with a timestamp showing when backup created).
3. When case matches the following condition, it is strongly recommended to turn off archive mode
before starting the restoration and to activate it again when restoration ends.
◦ Case condition: DB runs in archive mode, only one application configured to use the DB (STMS in
this case) and DB is large. By doing so, will dramatically reduce the restoration time.

Warning
Only one backup or restore can run at once on the same Oracle DB server. If you rune more than
one backup, the following message appears:
ERROR!! FAILED can't run while OraDBBackup running in another session
Aborting...
Check Log file: /var/ORACLE/logs/OraDBBackup.log for more details.

Ribbon Communications Inc. Proprietary 71

 Users and Security

Start
EmsStmsDBBackup [-backup | -restore | -purge | -auto ] [ -noconsistent ] [ -N
num ] [-h]
Where:

-backup perform schema backup (default option)

-restore perform schema restore

-n number of backups to remain after purge (used with -auto)

-purge delete obsolete backup set

-auto special mode: purge then backup at once

-noconsistent backup will be no consistence as cross-table consistency

Ribbon Communications Inc. Proprietary 72