cc/td/doc/product/rtrmgmt/optnet/ctm
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Using Cisco Transport Manager

Using Cisco Transport Manager

This chapter:

Installation Guidelines

Follow these guidelines when installing the CTM client and server. For the exact installation procedure, refer to the Cisco Transport Manager Installation Guide.


Step 1 Prepare the platform for installation. See the "System Requirements" section.

Step 2 Before installing the CTM server, verify that Oracle8 is installed.

Step 3 Complete the installation checklist:

Step 4 Install the CTM server and client.

Step 5 After the installation is complete, test and troubleshoot your setup.


Figure 2-1 summarizes the installation guidelines in a flowchart.


Figure 2-1: Installation Flowchart


Figure 2-2 describes how to get started after installing the CTM client and server.


Figure 2-2: CTM Management Domain Setup


Overview of Security Levels

The following security domains govern Cisco ONS 15303, Cisco ONS 15304, and Cisco ONS 15454 networks:

Administrator and Operator Privileges

All CTM users belong to one of two groups:

    1. Administrators: Typically network operation center supervisors with superuser rights. When logging in, administrators have no maximum number of login attempts.

    2. Operators: Typically users who manage specific NEs. For security reasons, operators have a maximum of three login attempts when logging in. The operator's user account is disabled after the third unsuccessful login attempt, and the operator must contact the CTM administrator to reenable the user account. Each operator can have only one active session.

Each CTM user has a user profile that defines the capabilities for that user. See Table 2-1.


Table 2-1: CTM User Profile
Capability Administrator Operator

Login

No maximum number of login attempts

Maximum of three login attempts

  • Access CTM Server Control Panel window

  • Create, delete, and modify CTM user profiles

  • Add, delete, and modify topology objects

  • Download software

  • Back up and restore memory

  • Specify the software version supported on selected NEs

  • Add Cisco Transport Controller (CTC) binaries to the CTM database

  • Schedule and cancel administrative tasks

  • Set up global application-specific parameters

  • View audit and error logs

Allow

Deny

Remaining CTM features

Allow

Allow

The CTM client GUI has the following features accessible to administrators only:

CTM Client Administration

Default Client Configuration

The default client configuration consists of parameters that bring up the client and allow the client to talk to the server. By default, client configuration information is stored in the following location:

C:\Cisco\TransportManagerClient\config\ems-client.cfg
 

During installation, the following parameters are required for each user:

CTM_Port=27613

Per User Client Configuration

When users first log in, they receive default user properties that the administrator has set up. Then, any user preferences that users select override the default properties. The per-user client configuration is dynamic to the user, whereas the default client configuration is static to the client.

For information on setting user preferences, see the "Setting and Saving User Preferences" section.

Key GUI Components

The CTM client graphical user interface (GUI) is an intuitive Java-based interface that provides a native "look-and-feel" on both Microsoft Windows and Sun Solaris platforms. The key GUI components are described in the following sections.

The CTM Dashboard

The CTM Dashboard shows useful alarm and connectivity information in one easily accessible location. See Figure 2-3.


Figure 2-3: The CTM Dashboard


The Domain Explorer

The Domain Explorer is CTM's home window and provides a logical view of the network and provides alarm, connectivity, and operational status. Administrators use the Domain Explorer to create groups of NEs and organize the domain in a hierarchy. See Figure 2-4.


Figure 2-4: The Domain Explorer


The Domain Explorer window is divided into two sections: the topology tree and the property sheets. The topology tree consists of a management domain, groups, and NEs, which appear in a hierarchical format. The top level of the hierarchy is the management domain, followed by groups, and then NEs. You can drag and drop NEs to reposition them in the topology tree. Groups and NEs can exist in multiple locations in the topology tree.

By default, a group of discovered network elements is added during installation. The CTM server uses this group to add all Cisco ONS 15454s discovered in the domain. Administrators cannot delete this group of discovered NEs. Administrators can move or copy NEs out of the group of discovered NEs, but cannot move or copy NEs into the group.

The Topology Explorer

The Topology Explorer window provides a physical view of all the subnetworks and NEs currently being monitored by CTM. A subnetwork is an interconnected set of NEs within a layer network that shares common characteristics, such as interconnection capacity or bandwidth. The Toplogy Explorer also shows the alarm, connectivity, and operational status of subnetworks and NEs. See Figure 2-5.


Figure 2-5: The Topology Explorer


The Alarm Browser

The Alarm Browser window highlights fault conditions occurring on either the physical equipment or the facilities terminating or traversing the NE. The Alarm Browser window lists conditions that are assigned an alarm severity level of critical, major, minor, or cleared (if selected). See Figure 2-6.


Figure 2-6: The Alarm Browser



Table 2-2: Functionality of Alarm Browser Icons
Toolbar Icon Functionality

Reset All Alarms/Events from View

Clears all alarms from the Alarm Browser window.

Acknowledge Alarms

Allows you to acknowledge the selected alarms (when this feature is enabled by the administrator).

Show Note

Allows you to view any comments that were entered for the selected alarm and enter additional comments.

Hide Cleared Alarms

Hides all alarms that have been cleared.

Hide Acknowledged Alarms

Hides all alarms that have been acknowledged.

The Shelf View

The Shelf View displays a graphical representation of the NE and its basic system information. For Cisco ONS 1530x NEs, the Shelf View shows a front-panel view of the chassis with its cards, fan tray, status LEDs, and patch panel of Ethernet and DS-1 or E1 ports. Real-time information on alarm LEDs appears; changes to other LEDs might take a few minutes to appear due to the polling interval. The Shelf View provides a summary of NE configuration, number of active alarms, and other information useful for fault monitoring. See Figure 2-7.


Figure 2-7: The Shelf View


For Cisco ONS 15454 NEs, CTM launches the Cisco Transport Controller (CTC), which shows a shelf view of all line cards, alarm status, and navigation to all provisioning functions.

The Domain Map

The Domain Map window lets you see the partitioning of the network. The Domain Map is organized into a multilevel hierarchy that corresponds to the structure of your Domain Explorer and Topology Explorer trees. The Domain Map hierarchy consists of management domains, subnetworks, groups, and NEs, which graphically appear. The Domain Map lets you visualize the structure of your network and customize node positions, node icons, and background map images. You can also create and modify links between distinct nodes. See Figure 2-8.


Figure 2-8: The Domain Map


You can open the Domain Map for a group, for a subnetwork, or for the CTM domain. Select a node in the Domain Explorer or Topology Explorer tree and choose File > Domain Map.


Note If you select an NE node in the Domain Explorer or Topology Explorer tree, the Domain Map menu bar and toolbar icon are dimmed. For an individual NE, open the Shelf View---not the Domain Map.

The Cross-Connect Map

The Cross-Connect Map shows the internal port mapping configuration between Ethernet ports and virtual tributaries (VT1.5s) and DS-1 ports and VT1.5s on Cisco ONS 15303 NEs. For Cisco ONS 15304 NEs, the Cross-Connect Map shows the port mapping between Ethernet ports and virtual channels (VC-12s), and E 1 ports and VC-12s. Each port is color coded. When you open the window, all current cross-connects are shown. A port and its associated VT1.5s or VC-12s share the same color. If you select one port, only its corresponding VT1.5s or VC-12s are highlighted while the rest of the ports are dimmed. See Figure 2-9.


Figure 2-9: The Cross-Connect Map


The NE Explorer

The NE Explorer window shows service provisioning information about the selected Cisco ONS 1530x NE. The NE Explorer window consists of a topology tree on the left side of the window and a property sheet on the right. The topology tree shows all the interfaces for the selected NE. The property sheet shows information about the selected entity (NE, port, and so on). The NE Explorer has a specific selection context, meaning it shows different property sheets depending on whether it was opened for a SONET or an SDH NE. See Figure 2-10.


Figure 2-10: The NE Explorer


Service provisioning information is available for the Cisco ONS 15454 by using CTC.

The Server Control Panel

The Server Control Panel window lets you view and modify certain server configuration parameters. The left side of the window displays the topology tree, which contains the different CTM server functions and services. The right side of the window displays the property sheet that corresponds to the selected server component. See Figure 2-11.


Figure 2-11: The Server Control Panel


Accessing the Online Help

The online help provides a detailed explanation of each CTM GUI window and dialog box.

To access the online help for any CTM window:

or

To access the online help for any CTM dialog box, click the Help button within the dialog box.

To access the online help contents, click the Contents link in any online help page.

Managing the CTM Administrative Domain

Adding a New Group


Step 1 Log in to the CTM client with administrative privileges.

Step 2 Select the management domain node or a group node in the Domain Explorer tree.


Note You cannot add a new group to the group of discovered nodes.

Step 3 Click the New Group toolbar icon (or choose File > New Group).

Step 4 The New Group dialog box opens. In the Group ID field, enter a unique name for the group.

Step 5 (Optional) Enter a geographic location and description of the group.

Step 6 Click OK to add the new group to the Domain Explorer tree.


Adding a New Subnetwork


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose File > Topology Explorer.


Note  To access the Topology Explorer, the domain must contain at least one NE. If the domain does not contain any NEs, the Topology Explorer toolbar icon and menu option are dimmed.

Step 3 In the Topology Explorer window, choose File > New Subnetwork.

Step 4 The New Subnetwork dialog box opens. In the Subnetwork ID field, enter a unique name for the subnetwork.

Step 5 (Optional) Specify the GNE ID, subnetwork type and topology, and a description of the subnetwork.

Step 6 Click OK to add the new subnetwork to the Topology Explorer tree.


Adding a New NE


Step 1 Log in to the CTM client with administrative privileges.

Step 2 Select the management domain node or a group node in the Domain Explorer tree.


Tips Do not select the discovered NEs node.

Step 3 Click the New Network Element toolbar icon (or choose File > New Network Element).

Step 4 In the New Network Element dialog box, enter the appropriate information.

Step 5 Click OK to add the new NE to the Domain Explorer tree.


Using ONS as a GNE

With the ONS GNE mode, you can configure one or more NEs as GNEs.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 Select a management domain node or a group node in the Domain Explorer tree.

Step 3 Click the New Network Element toolbar icon (or choose File > New Network Element).

Step 4 In the New Network Element dialog box, enter the appropriate information. In the GNE ID field, choose <SELF>. Choosing <SELF> as the GNE ID adds an entry in the GNE Table for that NE and creates a corresponding subnetwork.

Step 5 Click OK to add the NE as the GNE.


Copying NEs from One Group to Another

CTM allows you to easily create domains for multiple users. You can copy the same NE in different domains, so that users who work different shifts can access the same NE.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, select the NE you want to copy.

Step 3 Click the Copy toolbar icon (or choose Edit > Copy). This copies the NE to the clipboard (notice the NE now appears in italics).

Step 4 Select the group or management domain node where you want to paste the NE and click the Paste toolbar icon (or choose Edit > Paste). This pastes the contents of the clipboard under the selected node.


Note You cannot paste an NE in a group where the same instance of the NE already exists.



Tips  You can also copy NEs by using the drag and drop feature. Hold down the Ctrl key on your keyboard and by using your mouse, drag and drop the NE in the new location.

Moving NEs from One Group to Another

CTM provides you with drag and drop capabilities, allowing you to easily move NEs from one group to another.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, select the NE you want to move.

Step 3 Hold down the Ctrl key on your keyboard and by using your mouse, drag the selected NE to a new location.

Release the Ctrl key and the mouse button. The NE moves from the old location to the new location.



Tips You can also move NEs using the Cut and Paste toolbar icons.

Removing a Group


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, select the group you want to delete.


Note  Before you can delete a group, you must move all NEs that the group contains to a different group.

Step 3 Click the Delete toolbar icon (or choose Edit > Delete).

Step 4 Click OK to remove the group from the Domain Explorer tree.


Removing a Subnetwork


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, choose File > Topology Explorer.

Step 3 In the Topology Explorer tree, click the subnetwork you want to delete.


Note You can delete only an empty subnetwork from the topology tree. An empty subnetwork is one that does not contain any NEs. You cannot delete the last subnetwork associated with a GNE.

Step 4 Click the Delete toolbar icon (or choose Edit > Delete).

Step 5 Click OK to remove the subnetwork from the topology tree.


Removing an NE


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, click the NE you want to delete.


Note  To delete the last instance of an NE, you must use database pruning. For more information, see the "Pruning the Database" section.

Step 3 Click the Delete toolbar icon (or choose Edit > Delete).

Step 4 Click OK to remove the NE from the Domain Explorer tree.


Customizing the Domain Map

Map background images should be a minimum of 640 x 480 pixels and a maximum of 1024 x 768 pixels. Images smaller than 640 x 480 pixels appear surrounded by blank space in the upper-left corner of the window. Images larger than 1024 x 768 pixels appear with scroll bars. Icon images are 32 x 32 pixels.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, click a node and choose File > Domain Map.

Step 3 Use the Edit menu in the Domain Map window to customize your Domain Map. Choose Edit > Enable Drag to enable drag & drop functionality and easily customize the network partitioning. Other Edit menu options include:



Tips You can choose whether multiple windows or a single window will be used for navigation. In the Domain Explorer window, choose Edit > User Preferences and click the Map Preferences tab. Click the Open Map in New Window check box to open a new window for subsequent map views, or leave the check box unchecked to open subsequent map frames in the same window.

Performing User Administration

Follow the procedures described in this section to create new CTM users, modify user properties, delete users, administer user security, and set user preferences.

Creating a CTM User


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > CTM Users.

Step 3 In the Cisco Transport Manager Users Table window, click the New User toolbar icon (or choose Edit > New User).

Step 4 In the New CTM User wizard, enter the following information; then, click Next:


Note  The user password must contain at least six characters. Of those six characters, at least one must be a nonalphanumeric character (*, &, -, %, and so on).

Step 5 If you are adding a new operator user, select groups and NEs that you want the operator to be able to monitor. (Administrators monitor the entire management domain, so you do not have to select groups or NEs if you are adding an administrator user.)

Step 6 In the CTC User Properties field, enter the Cisco Transport Controller (CTC) username and password for gaining access to Cisco ONS 15454 NEs.

Step 7 Click Finish.

The new user appears in the list of users in the Cisco Transport Manager Users Table.


Modifying a CTM User's Properties


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > CTM Users.

Step 3 In the Cisco Transport Manager Users Table window, select the CTM user whose properties you want to modify.

Step 4 Click the Modify User toolbar icon (or choose Edit > Modify User).

Step 5 The Modify CTM User Properties wizard opens. Modify the following information, as needed; then, click Next:


Note  The user password must contain at least six characters. Of those six characters, at least one must be a nonalphanumeric character (*, &, -, %, and so on).

Step 6 For operators users only, modify the list of objects assigned to the CTM operator. You can add groups or NEs to the Assigned Objects list, or remove groups or NEs from the list.

Step 7 (Optional) Modify the user's CTC username and password for gaining access to Cisco ONS 15454 NEs.

Step 8 Click Finish.

The user whose properties you modified appears in the list of users in the CTM Users Table.


Deleting a CTM User


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > CTM Users.

Step 3 In the Cisco Transport Manager Users Table window, select the CTM user you want to delete.


Note  You cannot delete a user from the database until that user logs out.

Step 4 Click the Delete User toolbar icon (or choose Edit > Delete User).

Step 5 Click OK to remove the user from the database.


Viewing Logged In CTM Users


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 In the Server Control Panel window, choose Administration > Logged In CTM Users.


Administering User Security Through Password and Account Status

For security reasons, CTM operators have a maximum of three login attempts when logging in; administrators have no maximum number of login attempts. The operator's user account is disabled after the third unsuccessful login attempt, and the operator must contact the CTM administrator to reenable the user account.


Tips To prevent a user from logging in, you can disable the user's login state or change the user's password. You also have the option of deleting the user account altogether.

To enable or disable a CTM operator's account or change the user password:


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > CTM Users.

Step 3 In the Cisco Transport Manager Users Table window, select a user.

Step 4 Click the Modify User toolbar icon (or choose Edit > Modify User).

Step 5 The Modify CTM User Properties wizard opens. In the User Password field, enter a new password for the CTM user.

Step 6 In the Confirm Password field, retype the newly modified password.

Step 7 In the Login State field, select either Enabled or Disabled; then, click Next until you reach the Finish screen.

Step 8 Click Finish.

The modified user appears in the list of users in the CTM Users Table.


Setting and Saving User Preferences


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer window, choose Edit > User Preferences.

Step 3 The User Preferences dialog box opens. Select the following settings for the CTM user interface:

Step 4 Click the Save current settings check box to allow the current settings to remain even after logging out. Administrators can also click the Save as the default User Template check box to save the current settings as the default for CTM users who are added in the future. Current CTM users who have not altered their default settings adopt the new default settings when they log out.


Note After you save your selections, all subsequent views use the saved preferences.


Sending Messages to Other Users

As the administrator, you can use the Notify Users dialog box to type and send a message to other CTM users. For example, you might want to use the Notify Users dialog box to alert all CTM users before shutting down the CTM server.


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer window, choose Fault > Notify Users.

Step 3 The Notify Users dialog box opens. In the Message Targets field, select recipients for your message: all CTM administrators or all CTM users.

Step 4 Type your message in the Message field.

Step 5 To send the message to the specified recipients, click Send. To cancel the message and close the dialog box, click Cancel.


Overview of Mapping a CTC User

By default, the Cisco ONS 15454 is configured with the administrator username "cerent454" with no password. When you create a new CTM user, you must specify a unique CTC username and password for the user to access CTC. You must also configure the CTC username and password on the Cisco ONS 15454 that the user will manage.

CTC has four levels of security: retrieve, maintenance, provisioning, and super-user. CTM has two levels of security: administrator and operator. On each Cisco ONS 15454 in the CTM domain, create four CTC users---one for each privilege level. See Table 2-3.


Table 2-3: Recommended CTC Users by Security Level
User Security Level

User1

retrieve

User2

maintenance

User3

provisioning

Administrator

super-user

If you create the users listed in Table 2-3 for each Cisco ONS 15454, you can provide CTM users with the appropriate username and password for CTC privilege levels. See table 2-3 for an example.


Table 2-4: Corresponding CTM and CTC Usernames
CTM User CTC User

CTMUser1

User1

CTMUser2

User2

CTMUser3

User3

Administrator

Administrator

If you set up CTM and CTC usernames as listed in Table 2-4, CTMUser1 has retrieve privileges on all Cisco ONS 15454s but cannot maintain or provision the device. CTMUser2 has retrieve and maintenance privileges but cannot provision the device.

Mapping a CTC User

To configure the CTC username and password on the Cisco ONS 15454:


Step 1 Log in to the CTM client with administrative privileges.

Step 2 Add the Cisco ONS 15454.

Step 3 Open the NE Explorer window for the Cisco ONS 15454.

Step 4 Create the user USER1 on the Cisco ONS 15454 with the password USER1-PASS.

Step 5 Open the CTM Users Table.

Step 6 Create the user CTMUSER1. When prompted for the CTC username and password, enter USER1 and USER1-PASS. This creates a CTM user who has access to the Cisco ONS 15454 through CTC.

Step 7 Repeat this procedure for every user and Cisco ONS 15454 NE in the CTM management domain.


Viewing the Status of Services Running on the CTM Server


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Service Monitor.

The Service Monitor Table opens, allowing you to view the status of the services that are currently running on the CTM server.


Adding a New NE Software Version to the CTM Domain

You can add or upgrade NEs with new software releases. The new version of software on the supported NE must be a minor upgrade from the default software version that CTM supports. Major upgrades to NE software might require upgrading CTM.


Caution We recommend that you use this feature only at the advice of a Cisco technical support engineer. If you make incorrect modifications to data in the Supported NE Table, the CTM server might not be able to communicate with one or more NEs in the domain.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Supported NE Table.

Step 3 Select an NE and choose Edit > Add.

Step 4 The Add Supported NE dialog box appears. The NE model and the NE version fields are initialized with the corresponding values in the row you selected. Modify the version string to match the exact version string of the upgraded software; then, click OK.


If the NE with the modified version string exists in the CTM domain, the CTM server attempts communication with it. The server will manage the NE if communication is established.

Specifying CTC Partitions

All Cisco ONS 15454s added to the CTM domain are used to access the other Cisco ONS 15454s that are discovered through them. These Cisco ONS 15454s are called GNE Cisco ONS 15454s, or topology hosts. When starting CTC for a particular Cisco ONS 15454, the GNE for that NE is specified in CTC. CTC can take more than one GNE as input and discover the nodes behind those GNEs.

In a stable network, if CTC is started with a particular set of GNEs, the CTC view that appears looks the same every time it is started with that set of GNEs. CTM tries to copy this behavior when starting CTC for a given NE.

If you select Administration > Global Preferences, you can specify the number of GNEs to provide to CTC when starting CTC. CTM uses this parameter and partitions the list of GNE Cisco ONS 15454s into partitions containing the number of GNEs you specified in the Global Preferences dialog box. This list is then passed to the CTC instance that is being started.

Viewing Circuit Information for Cisco ONS 15454 NEs


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer tree, select the Cisco ONS 15454 NE for which you want to view circuit information and choose Configuration > Circuit Table.

The Circuit Table window opens, showing circuit information for the entire network. A circuit describes a fixed-size bandwidth pipe that is fully cross-connected from one user-defined source point (node, slot, or port) to a second user-defined destination point, across some number of node-to-node SONET spans (zero if the circuit is local to a single NE).

Step 3 In the Circuit Table window, choose Configuration > Circuit Span Table. The Circuit Span Table window opens, showing information about all spans associated with the selected circuit.


Upgrading the CTC Binary File

As the administrator, you can upgrade the CTC binary file CMS.jar independently of other CTM product upgrades.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > CTC Upgrade Table.

Step 3 Choose Edit > Add (or click the Add CTC Binary toolbar icon) to open the Upload CTC Binary File dialog box.

Step 4 In the Upload CTC Binary File dialog box, enter the complete name of the CMS.jar file you want to upload. To make the upgraded CTC binary file the active file, click the Activate check box.

Step 5 Click OK. The CTC binary file appears in the CTC Upgrade Table.

Step 6 If you did not activate the binary file in Step 4, you can do so now. To make the upgraded CTC binary file the active file, choose Edit > Activate (or click the Activate CTC Binary toolbar icon).


Configuring Cisco ONS 1530x NEs

For Cisco Transport Manager Release 2.0, the remote console option allows you to configure Cisco ONS 1530x NEs. To configure by using remote console, you must set up IP connectivity. Future CTM releases will offer GUI-based NE configuration.


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer tree, select the Cisco ONS 1530x NE that you want to configure and choose Configuration > NE Remote Console.

Step 3 In the Remote Console window, log in to the NE as the administrator.

To configure the command-line interface (CLI), refer to the Cisco Optical Networking System 15303 Software Configuration Guide or Cisco Optical Networking System 15304 Software Configuration Guide.


Configuring Cisco ONS 15454 NEs


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, select the Cisco ONS 15454 NE that you want to configure and choose Configuration > NE Explorer.

This starts a Cisco Transport Controller (CTC) session for the selected Cisco ONS 15454. Use CTC to configure the Cisco ONS 15454.


Performing Task Administration

Follow the procedures described in this section to download new images to Cisco ONS 1530x NEs, restart an NE with a new image, back up and restore memory, and so on.

Downloading New Software Images to Cisco ONS 1530x NEs


Caution To download software images to NEs, we recommend that DCN bandwidth be 56 kilobits per second (kbps) or higher. If DCN bandwidth is less than 56 kbps, software download may take an extended period of time.

For example, a typical Cisco ONS 15303 or Cisco ONS 15304 software image is approximately 2.5 megabytes (MB). If you download a 2.5-MB file to a single NE over a 19.2-kbps link, it will take 15 to 30 minutes depending on the volume of traffic. If you are also using CTM ConnectWay, it may take 45 to 90 minutes to download the file. Performing software downloads in parallel increases the length of time by a multiple of the number of NEs targeted.


Note The CTM server internally restricts one software download operation per ring and GNE. If multiple software downloads are scheduled on the same ring at the same time, they are performed in sequential order.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, select a management domain or group that contains Cisco ONS 1530x NEs that are assigned an In Service or Under Maintenance operational state. Or, select an NE that is assigned an In Service or Under Maintenance state.

Step 3 Choose Administration > Software Download.

Step 4 The Software Download dialog box opens. In the Available NEs list, select the NEs that you want to receive the new software images.

Step 5 In the Source field, specify a location for the software image. By clicking the Local option button, you can browse for a software image in the local directory. Or, you can specify an image already on the server.

Step 6 In the Time field, set a time for software download. By clicking the Now option button, you are ready for software download to begin. Or, you can click the At Time option button and specify exactly when to begin software download.

Step 7 Click OK to initiate the software download procedure.

The image file is saved in the NE Flash memory as image file name.sec.

Step 8 Commit the software download by using the Task Monitor Table. See the "Restarting a Cisco ONS 1530x NE with a New Software Image" section.


Restarting a Cisco ONS 1530x NE with a New Software Image


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Task Monitor.

Step 3 In the Task Monitor table, select the task that corresponds to the successful software download.

Step 4 Choose Edit > Commit or click the Commit toolbar icon to restart the NE.


Backing Up Memory for Cisco ONS 1530x NEs

By default, the local CTM server automatically backs up memory for all Cisco ONS 1530x NEs on a daily basis for seven days.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, select a management domain or group that contains Cisco ONS 1530x NEs that are assigned an In Service or Under Maintenance operational state. Or, select an NE that is assigned an In Service or Under Maintenance state.

Step 3 Choose Administration > Memory Backup.

Step 4 The Memory Backup dialog box opens. In the Available NEs list, select the NEs for which you want to back up memory.

Step 5 In the Time field, set a time for memory backup. By clicking the Now option button, you are ready for memory backup to begin. Or, you can click the At Time option button and specify exactly when to begin backing up memory.

Step 6 Click OK to initiate the memory backup procedure.

The memory (configuration file) is copied to the file CTMSHOME/admin/NE system ID/startup-config-backup.


Restoring Memory for Cisco ONS 1530x NEs


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, select a Cisco ONS 1530x NE that is assigned an In Service or Under Maintenance operational state.

Step 3 With the NE selected, choose Administration > Memory Restore.

Step 4 The Memory Restore dialog box opens. The NE you selected in the topology tree appears in the Selected NEs list. If you want to choose a different NE, select the NE in the Selected NEs list and click the Remove button. Then, choose another NE from the Available NEs list and click the Add button.


Note You can run the Memory Restore procedure for only one NE at a time.

Step 5 In the Source field, specify a location for the configuration file that needs to be restored. By clicking the Local option button, you can browse for a local directory for the file to be restored. Or, you can restore the file from the CTM server.

Step 6 In the Time field, set a time for memory restore. By clicking the Now option button, you are ready for memory restore to begin. Or, you can click the At Time option button and specify exactly when to begin restoring memory.

Step 7 Click OK to initiate the memory restore procedure.


The file is saved in the NE Flash memory as startup-config.sec. CTM will not automatically apply this configuration file to running or startup. You must commit this change by using the Task Monitor Table. See the "Restarting a Cisco ONS 1530x NE with a New Software Image" section.

Monitoring Scheduled Tasks

The Task Monitor Table window provides information on scheduled administrative tasks---Memory Backup, Memory Restore, and Software Download. For example, you can view the system username of the person who entered a specific task, when the task began, and when the task ended.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Task Monitor.


To delete a task record from the Task Monitor Table list:


Step 1 In the Task Monitor Table list, select the task you want to delete.


Note  Delete is enabled only for tasks with a Succeeded, Canceled, or Failed status.

Step 2 Click the Delete toolbar icon (or choose Edit > Delete).


To cancel a scheduled task by using the Task Monitor Table:


Step 1 In the Task Monitor Table list, select the task you want to cancel.


Note  Cancel is enabled only for tasks with a Queued status.

Step 2 Click the Cancel toolbar icon (or choose Edit > Cancel).


Setting Global Preferences


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, select Administration > Global Preferences.

Step 3 In the Global Preferences dialog box, set the following application-specific parameters that will apply to all operators within the management domain:

Step 4 Click OK.


Tagging a Port "Under Maintenance"


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer tree, select the NE whose ports you want to tag "Under Maintenance."

Step 3 Click the Shelf View toolbar icon (or choose File > Shelf View).

Step 4 The Shelf View window opens. The Shelf View has graphical representations that correspond to each of the eight DS-1 or E1 ports and eight Ethernet ports. Select an in-service port and click the right mouse button.

Step 5 In the popup menu that appears, select the Tag Under Maintenance menu option.

Step 6 To verify that the port is tagged "Under Maintenance," position your mouse pointer over the port. The tooltip shows the current state.



Tips You can also use the Cross-Connect Map window to tag a port "Under Maintenance."

Overview of Monitoring and Isolating Faults

All NEs shown in the Domain Explorer tree have corresponding alarm icons that indicate whether the NE is experiencing a critical alarm, major alarm, or minor alarm.

The management domain node and group nodes also have alarm icons that reflect the highest alarm condition of the NEs contained in the domain or group node.

Alarm Levels

CTM reports the following alarms:

Critical Alarm

Critical Alarm conditions generally pertain to any posted state that indicates a signal of DS-3 rate or higher is experiencing trouble because of facility or equipment failure. Complete loss of system synchronization (if configured for external or line) also warrants a Critical value. Additionally, the loss of an Ethernet interface (equipment or Ethernet facility failure) is classified as a Critical Alarm condition.

Major Alarm

Major Alarm conditions generally pertain to any posted state that indicates an incoming signal between DS-1 and DS-3 is experiencing trouble because of facility or equipment failure. Additionally, if the system supports the ability to verify its program, memory, or database validity, off-normal states of these entities are posted as a Major Alarm condition. Loss of one of the two available references (when the NE is configured to obtain synchronization from both line references) is also a Major Alarm.

Minor Alarm

Minor Alarm conditions generally pertain to any posted state that indicates an off-normal state exists in which transmitted service is not impacted, yet there may be some impact to the network or equipment because of the off-normal condition. One example of an off normal is if there is a nonservice affecting loss of equipment redundancy.

Monitoring the Entire Domain or a Group of NEs


Step 1 Log in to the CTM client with administrator or operator privileges. In the Domain Explorer tree, look at the management domain node. If the management domain node shows a critical, major, or minor alarm icon, it means an NE within the management domain is experiencing an alarm.

Step 2 Select the management domain node and choose Fault > Alarm Browser (or right-click the node and select Alarm Browser in the popup menu that appears). This opens the Alarm Browser window, which shows all the NEs in the management domain that are experiencing a critical, major, or minor alarm.

Step 3 Return to the Domain Explorer tree and select a group node that shows a critical, major, or minor alarm icon, indicating that an NE within the group is experiencing an alarm.

Step 4 Choose Fault > Alarm Browser (or right-click the group and select Alarm Browser in the popup menu that appears). This opens the Alarm Browser for the selected group.

Step 5 Return to the Domain Explorer tree and select any NE. Click the Test NE Connectivity toolbar icon (or choose Fault > Test NE Connectivity) to ping the selected NE for connectivity.


Note To obtain the connectivity status of a Cisco ONS 15454 from the CTM client, set up at least one trap destination by using `public' as the SNMP community string on the Cisco ONS 15454. Refer to the CMS User Guide to configure the trap destination for a Cisco ONS 15454.


Identifying and Monitoring Alarms on an NE

The Shelf View allows you to drill down from the Domain Explorer and take a closer look at an individual NE. The Shelf View provides a graphical representation of the NE and its basic system information. Real-time information is displayed for alarm LEDs. Individual Ethernet and DS-1 or E1 ports that appear in green indicate an alarm-free state; ports that appear in red are experiencing an alarm. (Preprovisioned or out-of-service alarms appear in gray.)


Step 1 Log in to the CTM client with administrative or operator privileges.

Step 2 In the Domain Explorer tree, select an in-service NE that shows an alarm icon and choose File > Shelf View.

Step 3 In the Shelf View window, choose Fault > Alarm Browser. This opens the Alarm Browser window for the selected NE.

The Alarm Browser window lists critical, major, and minor conditions that have not been cleared. A condition is an occurrence on either the system equipment or the facilities terminating or traversing the equipment.

Step 4 The Alarm Browser allows you to acknowledge alarms. Select the alarms you want to acknowlede and click the Acknowledge Alarms toolbar icon. Click again to unacknowledge the selected alarms.


Note If the ability to acknowledge alarms has been disabled by the administrator, the Acknowledge Alarms icon is grayed out.

Step 5 Click the Show Note toolbar icon to view any comments that have been entered for the selected alarm and to enter additional comments


Drilling Down to a Specific Port or Component

For SONET nodes, the Cross-Connect Map window shows the internal port mapping configuration between Ethernet ports and virtual tributaries (VT1.5s), and DS-1 ports and VT1.5s. For SDH nodes, the Cross-Connect Map shows internal port mapping configuration between Ethernet ports and virtual channels (VC-12s), and E1 ports and VC-12s. Each port is color-coded. When you open the window, all current cross-connects are shown. A port and its associated VT1.5s or VC-12s share the same color. If you select one port, only its corresponding VT1.5s or VC-12s are selected, while the rest of the ports are dimmed.


Step 1 Log in to the CTM client with administrative or operator privileges.

Step 2 In the Domain Explorer tree, select an NE that shows an alarm icon.

Step 3 Click the Cross-Connect Map toolbar icon (or choose Configuration > Cross-Connect Map).

Step 4 Click the Quick Help toolbar icon (or choose Help > Quick Help) to view the icon legend at the bottom of the Cross-Connect Map. The icons listed from Critical Alarm to Out of Service appear beside the corresponding ports.

Step 5 Right-click any of the selectable items in the Cross-Connect Map. In the popup menu that appears, select the Alarm Browser menu option to open the Alarm Browser window for the selected item.


Logging Alarms and Events to a Text File

You can use the Event Export Manager to export alarms and events as they occur to the file you choose. In addition, you can set various export parameters to refine the export.


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer window, choose Fault > Event Export Manager.

Step 3 The Event Export Manager opens. In the Network Elements field, select NEs and add them to the Selected list or remove selected NEs and return them to the Available list.

Step 4 In the Alarm Severity field, select Critical, Major, Minor, Clear, and/or Not Alarmed check boxes. Alarms and events with a corresponding severity level will be exported.

Step 5 Specify a destination for the file in the Export To field. By clicking the Browse button, you can browse for a particular destination. In addition, you can overwrite or append the file.

Step 6 Select a field separator type in the Export Options field. In addition, you can click the Stop Export when check box, enter a number of records, and thereby instruct the Event Export Manager to stop exporting after a user-specified number of records are logged.

Step 7 Click the Start Export toolbar icon. The Event Export Manager exports events to the specified file until you click Stop Export, or until the current CTM session ends.


Using Visual and Audible Alarm Notification Facilities


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer window, choose Edit > User Preferences.

Step 3 The User Preferences dialog box opens. In the Show Notification Dialog For field, select whether or not an alert popup appears when a specific alarm or informational event occurs on NEs in your management domain or on the CTM application.

Step 4 In the Play Audible Notification For field, select whether or not an audible alert is sounded when a specific alarm or informational event occurs on the NE or CTM application.

Step 5 Click the Save current settings check box and click OK.


Viewing the Historical Event Database

An event is an autonomous message output by the NE, triggered either by a standing condition or a transient condition. The Event Browser window lists all nonalarmed events that occurred during a specified period for the selected node.

By default, the Event Browser window shows event information that occurred during the last four hours. You can use the pull-down menu to the right of the time-based filter toolbar icon to filter event data for the past 4 hours, past 8 hours, past 12 hours, past day, or past week.


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer tree, select the management domain, group, or NE node for which you want to view historical alarms and events.

Step 3 Choose Fault > Event Browser (or right-click the node and select Event Browser in the popup menu that appears). This opens the Event Browser window for the selected node.


Viewing Performance Data

CTM provides rich monitoring functionality in the area of performance management (PM). PM data is useful for fine tuning the performance of the device and monitoring for potentially alarm-causing events. The NE generates PM statistics in 15-minute intervals over an 8-hour period. At the end of the 8-hour period, the statistic counters are rolled over.


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer tree, select the management domain, group, or NE node for which you want to view historical performance data.

Step 3 Open the PM table for SONET facilities, SDH facilities, or DS-1, DS-3, E1, or Ethernet ports, as follows:



Note On all PM tables except the Ethernet PM tables, certain intervals might appear with a red background. Red-colored intervals indicate that a threshold crossing alert (TCA) has been generated for that period.

Observing Real-Time Performance Data for Cisco ONS 1530x NEs

You can use the Real-Time Graph window to graph PM parameters that you select. The Real-Time Graph polls the Cisco ONS 1530x NE once every minute and stops automatically after four hours (240 poll samples).


Note  To view real-time performance data, you must first select a Cisco ONS 1530x NE that is either in service or under maintenance and available.

To open the Real-Time Graph window:


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer tree, select the Cisco ONS 1530x NE for which you want to graph PM data.

Step 3 Click the Cross-Connect Map toolbar icon (or choose Configuration > Cross-Connect Map).

Step 4 In the Cross-Connect Map window, select an in-service or preprovisioned port and click the Open Graph View toolbar icon. The Real-Time Graph dialog box opens.

Step 5 In the Real-Time Graph dialog box, select up to five parameters that you want to graph, then click OK. The Real-Time Graph window opens, showing the PM parameters that you selected.



Tips You can also open the Real-Time Graph from the Shelf View.

Observing Real-Time DS-1 Bit Error Rate Data

The DS-1 Real-Time BER window shows the line bit error rate (BER) for the selected in-service DS-1 port.


Note  To view the DS-1 BER, you must first select an NE that is either in service or under maintenance and available.

The BER is measured as the power of ten exponent x, as in BER = 10^(-x). For example, a value of -9 means that the BER on the selected DS-1 interface is 10^-9. The BER values range from -10 to 0, where -10 indicates that there is one bit error in every 10 billion bits, -1 represents one bit error in every 10 bits, and 0 indicates that the BER is not available. Lower values indicate better signal quality.


Note You can only access the DS-1 Real-Time BER window for in-service DS-1 ports; the BER menu option is dimmed for ports that are marked preprovisioned, out of service, or under maintenance.

To open the DS-1 Real-Time BER window:


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer tree, select the NE for which you want to view DS-1 BER data.

Step 3 Click the Cross-Connect Map toolbar icon (or choose Configuration > Cross-Connect Map).

Step 4 In the Cross-Connect Map window, select an in-service DS-1 port and choose Performance > DS-1 Real-Time BER (or right-click the DS-1 port and choose DS-1 Real-Time BER in the popup menu).



Tips You can also access the DS-1 Real-Time BER window from the Shelf View window.

Plotting Daily Ethernet Bandwidth Utilization

The Ethernet Bandwidth Utilization Graph window shows inbound and outbound WAN bandwidth information collected over time in the CTM database. When you open the Ethernet Bandwidth Utilization Graph, it shows a 48-hour window that includes the current day, plus data from 12:00 p.m. the previous day to 12:00 p.m. the next day. This 48-hour window shifts as you click the toolbar icons at the top of the window.


Step 1 Log in to the CTM client with administrative or operator privileges.

Step 2 In the Domain Explorer tree, select an NE node and click the Shelf View toolbar icon (or choose File > Shelf View).

Step 3 In the Shelf View window, select an Ethernet port and click the right mouse button. In the popup menu that appears, select the Ethernet Bandwidth Utilization Graph menu option. Or, select an Ethernet port and choose Performance > Ethernet Bandwidth Utilization Graph.

Step 4 To graph bandwidth utilization for a specific day, click the Fetch Data for a Specific Day toolbar icon. Specify month, day, and year, then click OK.



Note You can also open the Ethernet Bandwidth Utilization Graph from the Cross-Connect Map.

Changing the Ethernet Bandwidth Threshold

The Ethernet Bandwidth Utilization Graph shows utilization as a percentage of the subscribed maximum bandwidth. Bandwidth levels that exceed the Ethernet bandwidth utilization threshold appear in red; normal bandwidth levels appear in green. You can change the bandwidth threshold as follows:


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer window, choose Edit > User Preferences.

Step 3 In the User Preferences dialog box, click the Miscellaneous tab.

Step 4 In the Ethernet Bandwidth Utilization Threshold dialog box, specify a whole number from 1 to 99.

Step 5 Click OK.


Viewing Configuration Management Data

CTM provides rich monitoring functionality in the area of configuration management (CM). CM tables show configuration information that can be useful for debugging purposes. If an alarm occurs, you can access any of the configuration tables and look for a configuration error.


Step 1 Log in to the CTM client with administrative or operator privileges.

Step 2 In the Domain Explorer tree, select the management domain, group, or NE node for which you want to view historical CM data.

Step 3 Open the CM table for SONET facilities, SDH facilities, or DS-1, E1, or Ethernet ports, as follows:


Tips If the selected item has not been configured, the CM table fields appear blank and system defaults apply.


Viewing the NE Cross-Connect Configuration

For SONET nodes, the Cross-Connect Table window shows information about the internal port mapping configuration between Ethernet ports and virtual tributaries (VT1.5s), and DS-1 ports and VT1.5s. For SDH nodes, the Cross-Connect Table shows information about the internal port mapping configuration between Ethernet ports and virtual channels (VC-12s), and E1 ports and VC-12s. The port mapping was configured at the command-line interface (CLI).


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer tree, select the NE whose cross-connect configuration you want to view.

Step 3 Choose Configuration > Cross-Connect Table.

Step 4 Return to the Domain Explorer window and click the Cross-Connect Map toolbar icon (or choose Configuration > Cross-Connect Map).


Exploring the NE Configuration in Detail

The NE Explorer window shows service provisioning information about the selected NE. The configuration information is derived from the command-line interface (CLI) configuration file that resides on the NE.

Similar to the Domain Explorer window, the NE Explorer window consists of a topology tree on the left side of the window and a property sheet on the right. The topology tree lists all the ports for the selected NE. The property sheet shows information about the selected entity (NE, port, and so on). The NE Explorer has a specific selection context, meaning it shows different property sheets depending on whether it was opened for a SONET or an SDH NE.


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer tree, select the NE whose configuration you want to view.

Step 3 Choose Configuration > NE Explorer.



Tips If nothing has been configured on the selected NE, the NE Explorer property sheets appear blank and system defaults apply.

Changing the Operational State of an NE


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer tree, select the NE whose operational state you want to change. The Network Element Properties sheet appears.

Step 3 In the Operational State field, select an operational state by using the pull-down menu. Possible values include:

Step 4 Click Save.


Note The number of in-service and under-maintenance NEs in the network is determined by your license count.


TimeSaver If an NE is brought down for maintenance, mark it Out of Service to prevent unnecessary polling traffic on the DCN.


Viewing Inventory of All Field-Replaceable Units Deployed for the CTM Domain


Step 1 Log in to the CTM client with administrator or operator privileges.

Step 2 In the Domain Explorer tree, select the management domain node.

Step 3 Choose Configuration > NE Inventory Table. This opens the NE Inventory Table window, which shows a complete list of the system inventory for all NEs in the CTM domain.

The Field-Replaceable Unit column shows the name of the field-replaceable unit (FRU). The FRU is either the chassis, fan tray, SONET or SDH Access Module (SAM), or fuse.

Step 4 You can open the NE Inventory Table window for a particular group or NE. Simply select the group or NE in the Domain Explorer tree and choose Configuration > NE Inventory Table.


Viewing PM, CM, and FM Data for a Set of NEs

All performance management (PM), configuration management (CM), and fault management (FM) tables---Alarm Browser and Event Browser---have a Filter toolbar icon that lets you filter data for a set of NEs.


Step 1 Log in to the CTM client with administrative or operator privileges.

Step 2 In the Domain Explorer tree, select the management domain, group, or NE node for which you want to view PM, CM, or FM data.

Step 3 Open a PM, CM, or FM table under the Performance, Configuration, or Fault menu.

Step 4 Within the table, click the Filter toolbar icon (or choose File > Filter). The Filter dialog box opens.

Step 5 In the Filter dialog box, select the NEs that you want to include in the filter. Specify other filter parameters, as needed.

Step 6 Click OK to show the results in a table.


Exporting Information in PM, CM, or FM Tables to a Text File or HTML File

All PM, CM, and FM tables have an Export toolbar icon that lets you select a browser to use for viewing the report.


Step 1 Log in to the CTM client with administrative or operator privileges.

Step 2 In the Domain Explorer tree, select the management domain, group, or NE node.

Step 3 Open a PM, CM, or FM table under the Performance, Configuration, or Fault menu.

Step 4 Within the table, click the Export toolbar icon (or choose File > Export). The Export dialog box opens.

Step 5 In the Export dialog box, specify whether you want to export data in comma-separated value format, tab-separated value format, or another user-specified format.

Step 6 Specify a location for the file in the Export to file text box. Or, click Browse to browse for a destination location.

Step 7 Click OK to export the file.

Step 8 (Optional) Retrieve and print the file.


Starting and Stopping the CTM Server

A complete set of administrative procedures---or scripts---is added to the application during installation. One procedure automatically starts the CTM server every time the workstation is started. Other procedures allow you to start or stop the server as necessary. These procedures are located in the directory /opt/CiscoTransportManagerServer/bin.

The command ctms-start sets the appropriate environment variables and starts the CTM server. The amount of time it takes for the CTM server to start varies based on the number of NEs in the configuration and the size of the database. Use ctms-start only when the CTM server has stopped.

The command ctms-stop stops the CTM server. The stop procedure gracefully shuts down the server and cleans all memory and connections. The overall process takes less than 5 minutes.

Viewing and Modifying the Server Configuration

The Server Control Panel window shows the CTM server configuration and allows you to modify the configuration. Certain modifications take effect immediately and change the server's active configuration. Other changes take effect when the server is restarted.

The different property sheets within the Server Control Panel window allow you to start or stop performance monitoring, CTM GateWay TL1, or CTM GateWay SNMP services. Only CTM users who are logged in with administrative privileges can access the Server Control Panel window.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.


Adding New Licenses


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 Choose Administration > Add License to increase the number of monitored NEs or the number of logged in CTM users.

Step 4 In the Add License dialog box, enter the new license by using the format xxxx-xxxx-xxxx-xxxx, where x is either a number (0 to 9) or a letter (A to Z).

Step 5 Click OK to add the new license.


Viewing the Database Configuration


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 In the Server Control Panel window, click the DB icon to open the Database Configuration property sheet.


The Database Configuration property sheet shows the configuration that the CTM server uses to connect to the Oracle database. Once set up during installation, this configuration typically does not change.


Caution Changes made to the database configuration may cause the CTM server to fail.

Setting Up and Viewing Error Logs

The Error Log Configuration property sheet allows you to control the volume of messages that the CTM server outputs. All changes take effect immediately and do not require restarting the CTM server. To reduce the amount of information logged to the database, you can turn off entire components (CTM, CTM GateWay/SNMP, and CTM GateWay/TL1 mediation).


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 Click the ER icon to show the Error Log Configuration property sheet.

Step 4 In the Error Level field, choose the error level to include in the error log (Critical, Major, Minor, Informational, Debug, or Trace). Critical, major, minor, and informational errors are logged to the database; trace and debug information is logged to a log file.


Note You will run out of disk space if the trace or debug option is left on. Use trace or debug only when troubleshooting with a customer support engineer.

Step 5 In the Error Logging Services field, select services related to CTM, CTM GateWay/SNMP, and/or CTM GateWay/TL1 to include in the error log. (Note that if a service is not running, it is dimmed.)

Step 6 Click Save.

Step 7 In the Server Control Panel window, choose Administration > Error Log to open the Error Log window.


The Error Log window shows CTM server error information that is useful for debugging purposes. The error log captures abnormal and significant events based on severity. Table 2-5 shows the severity levels.

All messages are logged to the file CTMerror.log located in the directory /opt/CiscoTransportManagerServer/log. After you reset the error log level to critical, major, minor, or informational, you can remove the file CTMerror.log to free up disk space. Each time a new CTMerror.log is started, a backup of the previous file is kept in CTMerror.log.bak. You can remove the backup file at any time.


Table 2-5: Severity Levels and Error Log
Severity Level Description

critical

major

minor

informational

When set to any of these severity levels, all messages corresponding to the selected severity level or higher are logged to the database.

debug

trace

When set to debug or trace, all informational messages and higher are logged to the database.

Viewing the Audit Log

The Audit Log window contains information about significant events that occurred on the CTM server during a specific time period. The Audit Log is implemented as a file in the CTM database, where each record has a time stamp, record type, and message string.

Type of Information Logged

The Audit Log records the following information for monitoring purposes:


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Audit Log.


Stopping or Starting Performance Monitoring

The Performance Monitoring Service property sheet allows you to stop or start global PM data collection at any time.


Caution If DCN bandwidth is 128 kilobits per second (kbps) or less, performance monitoring is not recommended.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 In the Server Control Panel window, click the PM icon to open the Performance Monitoring Service property sheet.

Step 4 If you click the Stop button in the property sheet, all the NEs monitored by the CTM server will stop collecting PM data. Click Start to resume PM data collection.


You can also stop or start PM data collection for individual NEs.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, select the NE node for which you want to stop or start PM data collection. The Network Element Properties sheet appears.

Step 3 Select the Status tab and in the PM Collection State field, specify whether you want to enable or disable PM data collection.

Step 4 Click Save to save your changes to the database.


Starting or Stopping TL1 Mediation

Use the GateWay/TL1 Service property sheet to start, stop, or configure service-level parameters. This service can be started if the CTM server will integrate with an OSS. Based on the type of OSS, various TL1 mediation parameters can be changed.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 In the Server Control Panel window, click the GW icon to open the GateWay/TL1 Service property sheet.

Step 4 Modify the parameters; then, click Save. Changes take effect only after the server is restarted.


Starting or Stopping SNMP Service

Use the GateWay/SNMP Service property sheet to start, stop, or configure service-level parameters.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 In the Server Control Panel window, click the GW icon to see the GateWay/SNMP Service property sheet.

Step 4 Modify the parameters. The SNMP Hosts field shows the IP address of the host to which each SNMP trap will be forwarded. You can enter up to 16 IP addresses or host names. Valid host names are automatically converted to the corresponding IP address.

Step 5 Click Save. Changes take effect only after the server is restarted.


Changing the CTM Server Port

Use the NE Poller Service property sheet to change the CTM server port. All CTM clients use the CTM port to connect to the CTM server.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 In the Server Control Panel window, click the NE icon to see the NE Poller Service property sheet.

Step 4 Change the server port in the CTM Server Port field; then, click Save. Changes to this parameter take effect only after the server is restarted.


Changing Timing Parameters

Use the NE Poller Service property sheet to tune timing parameters and accommodate different CTM server-to-NE connectivity scenarios. When you tune timing parameters, you optimize network utilization and CTM server load. As a rule, timing parameters increase as the network slows.


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 In the Server Control Panel window, click the NE icon to see the NE Poller Service property sheet.

Step 4 Modify the different timing parameters; then, click Save. Changes take effect immediately.


Overview of Administering Your Database

This section describes procedures to administer the Oracle database and deals specifically with CTM data stored in the database. For a complete description, refer to Oracle's documentation---specifically the Oracle8 Server Administrator's Guide.

Another useful tool for administering the database is the Oracle Enterprise Manager, part of the Oracle8 Client CD. The Oracle Enterprise Manager provides an integrated solution for managing your heterogeneous environment and combines a graphical console, agents, common services, and tools to provide a comprehensive systems management platform for managing Oracle products.

Accessing the Database by Using SQL*PLUS Client

You can access the database and CTM schema objects by using the SQL*PLUS client that ships with Oracle products. You can use the SQL*PLUS client with a Microsoft Windows NT, 95, or 98 PC or a Sun Solaris workstation. Refer to Oracle's documentation to install and run SQL*PLUS client from a Windows NT, Windows 95, or Windows 98 PC.

On a Sun Solaris workstation, the SQL*PLUS client is installed as part of the Oracle server installation. The following guidelines will help you log in to SQL*PLUS as a CTM user and administer CTM schema objects and data. Refer to the SQL*PLUS User Guide for a complete description.


Step 1 On the Sun Solaris machine running Oracle, log in as the Oracle owner user. Use the username that was used when installing Oracle8.


Note To verify the username, enter the command id on the shell.

Step 2 Verify that the following UNIX environment variables for the Oracle user are set correctly:

Step 3 On the command line, enter the command sqlplus ctmanager/visionway. You should see a message that says "Connected to: Oracle8..." and see the SQL> prompt. If not, return to Step 1 and check your username and settings.

Step 4 You are now inside SQL*PLUS and can enter any SQL command supported by Oracle. For a list of SQL commands supported by Oracle, refer to the SQL*PLUS User Guide.


Basic SQL Commands for Accessing CTM Schema Objects

Table 2-6 lists commands that you can use to access, update, or modify CTM schema objects. You run each command in SQL*PLUS by typing the command at the SQL> prompt.


Table 2-6: SQL Commands to Access CTM Schema Objects
SQL Command Description
select table_name from user_tables;

Returns a list of all table names owned by the user ctmanager.

select view_name from user_views;

Returns a list of all views owned by the user ctm.

describe table_name or view_name;

Takes a table_name or view_name as a parameter (valid table names and view names are those returned by the previous two commands) and lists the name, type, and size of columns of the table or view.

select col1, col2 coln from table_name or view_name;

Takes column names col1.coln and table_name or view_name as parameters and displays data for all the columns listed. To display data for all columns, use * instead of col1, col2, and so on.

select col1, col2... coln from table_name or view_name where col1 = value1 AND col2 = value2...
 

Takes column names col1...coln and table_name or view_name as parameters and displays data for all the columns listed that meet the condition specified in the where clause. For example, select nedbaccessid from pl_ne_info_table where nesysid = 'ANGEL'; returns the value of column nedbaccessid from table pl_ne_info_table for all rows for which nesysid = ANGEL.

delete from table_name;

Takes table_name as a parameter and deletes the entire contents of the table.

Pruning the Database

During the CTM server installation, you can choose an option to prune the database automatically. If you do so, all performance management (PM) data, alarm data, event data, audit log data, and error log data older than 30 days will be pruned nightly at 2:00 a.m.

You can specify the number of days' worth of data to save before running the automatic database pruning script. Complete the following steps:


Step 1 Log in to the CTM client with administrative privileges.

Step 2 In the Domain Explorer window, choose Administration > Server Control Panel.

Step 3 In the Server Control Panel window, click the DB icon to open the Database Configuration property sheet.

Step 4 In the Database Configuration property sheet, click the Pruning Configuration tab. Specify the number of days' worth of data to save before running the database pruning script.


Tips You can save between 1 to 31 days of data, or you can select "Always" to save data indefinitely. Note that if you select "Always," you might run out of database space.

Step 5 After making your selections, click Save.


Using Pruning Scripts

You can run database pruning scripts to prune CTM data from the Oracle database at your convenience. Pruning scripts allow you to perform the following actions:

To run a pruning script:


Step 1 Log in as the root user on the Sun Solaris workstation where the CTM server is installed.

Step 2 Enter the command cd CTMSHOME directory on the UNIX shell to change directories to CTMSHOME, the CTM server home directory. The default is /opt/CiscoTransportManagerServer.

Step 3 Enter the command cd bin to change directories to bin.

Step 4 Enter the command ls -al prune* to see a list of pruning scripts.

Step 5 Select a script and a parameter (based on database pruning) and enter the corresponding command on the UNIX shell.

For example, if you want to prune error log data older than 25 days, enter the command prune_errlog.sh 25.


Table 2-7 describes parameters that can be passed to each script and tables that will be affected.

.
Table 2-7: Database Pruning
What to Prune (Script Name) Tables Affected Input Parameters Remarks

Prune audit log data (prune_auditlog.sh)

PL_AUDIT_LOG_TABLE

No. of days 1-31 or time stamp -t MM/DD/YYYY HH24:MI:SS

Removes all audit log entries that were created before n days or date and time.

Example: The command prune_auditlog.sh -t 03/24/1999 23:00:00 removes all audit log entries entered before 11:00:00 p.m. on March 24, 1999.

Prune error log data (prune_errorlog.sh)

PL_ERROR_LOG_TABLE

No. of days 1-31 or time stamp -t MM/DD/YYYY HH24:MI:SS

Removes all error log entries that were created before n days.

Prune event data (prune_events.sh)

PL_ALARM_EVENT_TABLE

No. of days 1-31 or time stamp -t MM/DD/YYYY HH24:MI:SS

Removes all event entries that were created before n days.

Prune PM data (prune_pm.sh)

PL_DATA_SERVICE_PM_TABLE

PL_SONET_OCN_PM_TABLE

PL_SONET_PATH_PM_TABLE

PL_SONET_VT_PM_TABLE

PL_DS1_PM_TABLE

Cerent_DS1_PM_TABLE

Cerent_DS3_PM_TABLE

Cerent_ETH_PM_TABLE

Cerent_SONET_LINE_PM_TABLE

Cerent_SONET_PATH_PM_TABLE

Cerent-_SONET_SEC_PM_TABLE

Cerent_SONET_VT_PM_TABLE

No. of days 1-31 or time stamp -t MM/DD/YYYY HH24:MI:SS

Removes all PM entries that were created before n days.

Remove an NE (prune_ne.sh)

Before using this script, shut down all CTM clients. Use the Server Control Panel window to stop CTM GateWay services.

PL_NE_INFO_TABLE

PL_NE_INVENTORY_TABLE

PL_DATA_SERVICE_PM_TABLE

PL_SONET_OCN_PM_TABLE

PL_SONET_PATH_PM_TABLE

PL_SONET_VT_PM_TABLE

PL_DS1_PM_TABLE

PL_ACTIVE_ALARM_TABLE

PL_ALARM_EVENT_TABLE

PL_NE_CONFIG_TABLE

PL_OC3_CONFIG_TABLE

PL_STS1_CONFIG_TABLE

PL_VT1_CONFIG_TABLE

PL_DS1_CONFIG_TABLE

PL_CROSS_CONNECT_CONFIG_TABLE

PL_CONFIG_ETHERNET_TABLE

PL_CONFIG_SERIAL_IF_TABLE

PL_CONFIG_MULTILINK_IF_TABLE

PL_CONFIG_EQUIPMENT_TABLE

PL_CONFIG_LAPS_TABLE

PL_CONFIG_ROUTE_MAP_TABLE

NE SYS ID

Removes all information about the NE from the database. Use this script with extreme caution.

Remove an NE (continued)

(prune_ne.sh)

Before using this script, shut down all CTM clients. Use the Server Control Panel window to stop CTM GateWay services.

PL_NE_PORT_STATUS_TABLE

PL_ADMIN_JOB_TABLE

PL_AREA_TREE_TABLE

PL_USER_MAP_TABLE

PL_SWAY_USER_PORT_TABLE

Cerent_DS1_PM_TABLE

Cerent_DS3_PM_TABLE

Cerent_ETH_PM_TABLE

Cerent_SONET_LINE_PM_TABLE

Cerent_SONET_PATH_PM_TABLE

Cerent_SONET_SEC_PM_TABLE

Cerent_SONET_VT_PM_TABLE

Cerent_NE_INVENTORY_TABLE

VW_CIRCUIT_TBL

VW_CIRCUIT_DEST_TBL

VW_CIRCUIT_VLAN_TBL

VW_CIRCUIT_SPAN_TBL

NE SYS ID

Removes all information about the NE from the database. Use this script with extreme caution.

Deleting Out-of-Service NEs

In the CTM Domain Explorer window, you cannot delete an NE without removing all instances of the NE from the database. Likewise, if you try to delete an NE from a group, that NE will still exist under the management domain.

However, you can completely remove an out-of-service NE from the database by using the prune_ne.sh script.

Enhancing Database Performance

The following guidelines are intended to help you enhance database performance when CTM clients access CTM data. For more detailed information, refer to Oracle's documentation---specifically the Oracle8 Tuning Guide.

Perform the following tasks periodically to improve performance:


Step 1 At least once every 15 days, run analyze_vw_objs.sql in the directory /opt/CiscoTransportManagerServer/bin.


Note The analyze_ctm_objs.sql script is provided with the CTM server.

Step 2 Tune Oracle database performance as outlined in "Part IV: Optimizing Oracle Instance Performance" in the Oracle8 Tuning Guide.


Backing Up and Restoring the Database

To back up and restore the database, refer to Oracle's documentation---specifically the Oracle8 Backup and Recovery Guide and the Oracle Enterprise Manager.

We recommend that you back up the following CTM tablespaces on a regular basis:


Tips If you are backing up PM data, back up the tablespaces at least daily.

Importing and Exporting CTM Data to and from the Oracle Database

You can use the Oracle Export utility to write data from an Oracle database to an operating system file in binary format. The file is then stored outside the database and read to another Oracle database by using the Import utility. For more information on using Oracle Import and Export utilities, refer to the Oracle8 Utilities document. Alternatively, you can use the Oracle Enterprise Manager to import and export data.

The Export utility provides a simple way to transfer data objects between Oracle databases. The Export utility extracts the object definitions and table data from an Oracle database and stores them in an Oracle binary-format export dump file located on disk or on tape.

The export dump file is then sent by using FTP---or, if on tape, physically transported---to a different site. By using the Import utility, the export dump file is transferred between databases that reside on machines not connected through a network.


Note Only the Oracle Import utility can read export dump files.

Removing CTM Schema Objects (User and Data) from the Database

If necessary, you can remove all CTM schema objects from the database; in doing so, however, you delete all CTM information from the database. An example of when you might want to remove all CTM schema objects from the database is when you are reinstalling the CTM server and do not care about data from a previously installed version.

To remove all CTM schema objects from the database:


Step 1 Shut down the CTM server and all CTM clients.

Step 2 On the Sun Solaris machine running Oracle, log in as the Oracle owner user. Use the username that was used when installing Oracle8.


Note To verify the username, enter the command id on the shell.

Step 3 Enter sqlplus on the command line.

Step 4 At the prompt, enter the Oracle DBA username and password. Default values are:

Username: system

Password: manager

Step 5 At the SQL prompt, enter the following commands:

drop user ctmanager cascade;
drop tablespace PL_DATA1_TABLESPACE including contents;
drop tablespace PL_DATA2TABLESPACE including contents;
drop tablespace PL_INDEX_TABLESPACE including contents;
exit;
 

Step 6 Change directories to the location of CTM Data1 tablespace. This was the first directory specified during the CTM server installation. The default location is /db02.

Step 7 At the Unix shell prompt, enter the command ls -alR ctmdata1. You should see files with names such as ctm_data1_0.dbf and ctm_data1_1.dbf. Enter the command /bin/rm -Rf ctmdata1.

Step 8 Change directories to the location of CTM Data2 tablespace. This was the second directory specified during the CTM server installation. The default location is /db03.

Step 9 At the Unix shell prompt, enter the command ls -alR ctmdata2. You should see files with names such as ctm_data2_0.dbf and ctm_data2_1.dbf. Enter the command /bin/rm -Rf ctmdata2.

Step 10 Change directories to the location of CTM Index tablespace. This was the third directory specified during the CTM server installation. The default location is /db04.

Step 11 At the Unix shell prompt, enter the command ls -alR ctmindex. You should see files with names such as ctm_index_0.dbf and ctm_index_1.dbf. Enter the command /bin/rm -Rf ctmindex.



hometocprevnextglossaryfeedbacksearchhelp
Posted: Wed Jul 12 10:38:24 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.