Cisco Transport Manager User's Guide, 7.0
Chapter 4: Maintaining an Efficient Network

Table Of Contents

Maintaining an Efficient Network

4.1  Overview

4.2  How Do I Manage the Database?

4.2.1  Viewing and Modifying Database Properties

4.2.2  Backing Up the CTM Database from the CTM GUI

4.2.3  Backing Up the CTM Database from the CLI

4.2.4  Restoring the CTM Database from the Previous Backup

4.2.5  Pruning the CTM Database

4.2.6  Using the SQL*PLUS Client to Manage the Database

4.2.7  Understanding Basic SQL Commands for CTM Schema Objects

4.3  How Do I Manage the Network Software?

4.3.1  Managing Binaries Using the CTC Upgrade Table

4.3.2  Software Management

4.3.3  Managing Cisco IOS-XR Software Packages

4.3.4  Using the Flash File Table

4.3.5  Viewing Software Versions and Restarting the NE with a New Software Image

4.3.6  Transferring Images

4.3.7  Adding a New NE Software Version to the CTM Domain

4.3.8  Deleting an NE Software Version from the CTM Domain

4.4  How Do I Modify the Network?

4.4.1  Changing IP Addresses for NEs

4.4.2  Updating the Configuration Files After Changing the CTM Server IP Address

4.4.3  Changing the Internal Subnet Address—ONS 15600

4.4.4  Viewing and Changing the Network Address—CTC-Based NEs

4.4.5  Configuring Proxy Server Settings—CTC-Based NEs

4.4.6  Changing the Operational State of an NE

4.4.7  Setting Date, Time, and Location on CTC-Based NEs

4.4.8  Configuring SNTP for Multiple NEs

4.4.9  Configuring Application-Specific Parameters

4.5  How Do I Manage Redundancy and Failover?

4.5.1  Backing Up Memory

4.5.2  Restoring Memory

4.5.3  Viewing and Modifying ONS NE Service Properties

4.5.4  Viewing and Modifying CTC Based Network Service Properties

4.5.5  Viewing and Modifying Service Instance Properties

4.5.6  Backing Up Client Files

4.5.7  Restoring Server Configuration Files

4.5.8  Initializing the Node Resync Process

4.5.9  Configuring Nodes for Database Restore—ONS 15600

4.5.10  Comparing Configuration Files—CRS-1 and XR 12000

4.5.11  Managing Protection Groups

4.5.12  Restoring NE Defaults

4.5.13  Configuring Card Redundancy

4.6  How Do I Monitor the Network?

4.6.1  Establishing a Telnet Session to a Node

4.6.2  Connecting to Nodes Through SSH

4.6.3  Monitoring a Network Element

4.6.4  Monitoring a Card with Chassis View

4.6.5  Monitoring a Line or Port with Chassis View

4.6.6  Monitoring Scheduled Tasks

4.6.7  Monitoring Service Status

4.6.8  Viewing the NE Discrepancy Table

4.6.9  Monitoring CTM Client and Server Configuration Details

4.6.10  Viewing the CTM Server and Client Version

4.6.11  Monitoring Network Manageability Statistics

4.6.12  Managing the VSI Controllers

4.7  How Do I Manage CTC Operations?

4.7.1  Functionality Provided in CTC that Is Not Available in CTM

4.7.2  Specifying CTC Partitions for CTC-Based NEs


Maintaining an Efficient Network


This chapter contains the following information to help you maintain an efficient network:

Overview

How Do I Manage the Database?

How Do I Manage the Network Software?

How Do I Modify the Network?

How Do I Manage Redundancy and Failover?

How Do I Monitor the Network?

How Do I Manage CTC Operations?


Note For information about configuring users and user-related parameters, creating and modifying advisory messages, and accessing logs, see Chapter 8, "Managing Security."


4.1  Overview

Maintaining your network focuses on tasks that will keep your network running smoothly. Examples include:

Backing up and restoring memory and the database

Creating and maintaining protection groups

Restoring default settings when necessary

Monitoring tasks and jobs

Modifying basic server and NE information

Finding modules or boards

Updating software images and versions

Exporting data and generating reports

Performing administrative database operations

4.2  How Do I Manage the Database?

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

A useful tool for managing the database is the Oracle Enterprise Manager, part of the Oracle 9i Client CD. The Oracle Enterprise Manager provides an integrated solution for managing heterogeneous environments and combines a graphical console, agents, common services, and tools to provide a comprehensive systems-management platform for managing Oracle products.

This section contains the following information:

Viewing and Modifying Database Properties

Backing Up the CTM Database from the CTM GUI

Backing Up the CTM Database from the CLI

Restoring the CTM Database from the Previous Backup

Pruning the CTM Database

Using the SQL*PLUS Client to Manage the Database

Understanding Basic SQL Commands for CTM Schema Objects

4.2.1  Viewing and Modifying Database Properties

The Database Properties pane in the Control Panel shows and defines database pruning parameters and the configuration that the CTM server uses to connect to the Oracle database. It contains the following tabs:

Configuration—Defines the values used by the CTM server to log into the Oracle database. Fields are grouped into two columns: After Restart and Active. The After Restart column shows the values that the CTM server uses after the server is restarted. The Active column displays the values currently used by the CTM server.

Pruning—Defines the CTM database pruning frequency. Database pruning is enabled by default. You can configure the performance monitoring (PM) pruning interval for 15-minute and 1-day data collection, giving you a finer level of control over the pruning of performance data from the system. Pruning frequency changes take effect as soon as you save them. You do not need to reboot the CTM server.

Database Operations—Allows you to start a database backup from the Control Panel. After entering the password, click Start to begin the database backup. This tab is disabled if the database is not installed in ARCHIVELOG mode. The ARCHIVELOG mode is stored in the CTM_config_table by the server installer.


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

Step 2 Click Database Properties to open the Database Properties pane. The following table provides descriptions.

Step 3 (Optional) Modify the values in the Configuration, Pruning, or Database Operations tabs.

Step 4 Click Save.


Table 4-1 Field Descriptions for the Database Properties Pane 

Field
Description
Configuration Tab

Database Server Configuration

(Read-only) Displays the size of the database server.

Enable ARCHIVELOG Mode check box

Click to enable ARCHIVELOG mode. When the database is in ARCHIVELOG mode, CTM supports automatic pruning of the /db05 partition.

Note When you enable the Enable ARCHIVELOG Mode check box, the Archive Log Pruning Parameters check box (located in the Database Operations tab) is automatically enabled.

Configuration Mode

Configuration Mode tells the CTM server the values to use to log into the Oracle database. When set to Auto, the CTM server uses the configuration that was set when CTM was installed. When set to Manual, the After Restart fields can be edited, and the CTM server will use the edited values when the server is rebooted.

Note If you change the configuration mode to Manual, enter the following commands to set the ORACLE_HOME (the C-shell is assumed for all UNIX commands) and ORACLE_SID environment variables before logging into CTM again:

setenv ORACLE_HOME <Oracle_home_directory>
setenv ORACLE_SID CTM
setenv LD_LIBRARY_PATH $ORACLE_HOME/lib
setenv PATH $PATH:$ORACLE_HOME/bin

Restart the CTM server after setting these environment variables. To do this, enter the ctms-stop command to shut down the CTM server. Then, enter the ctms-start command to restart it.


Caution If you set the configuration mode to Auto and restart the CTM server, the CTMServer.cfg file is overwritten with the Cisco default values for username, password, location, port, system ID, and SQL network alias.

Username

Displays the username that the CTM server uses to access the Oracle database.

Password

Displays the password that gives the username access to the Oracle database.

Location

Displays the IP address that the CTM server uses to connect to the database.

Port

Displays the port number that is used to connect to the database.

System ID

Displays the Oracle system ID. The ORACLE_SID specifies the system identifier (SID) value of the database instance that you create with the CTM installer. For a single-instance database, the SID value should be the same as the name of the database it manipulates (initialization parameter DB_NAME), and no more than four characters.

Note During CTM installation, the Cisco default system ID is CTM.

SQL Network Alias

Displays the SQL*Net listener alias set in the system listener.ora file. When the listener is running, entering the ps command displays the following output (not all systems display listener_alias):

tnslsnr [listener_alias] [-inherit]

Shadow processes (dedicated servers) spawned by the SQL*Net listener have the following syntax: oracleSID [(LOCAL=NO)]

Pruning Tab

PM Data (15 min)

Specifies the number of days to save 15-minute PM data before CTM runs the database pruning script. You can save from 1 to 1000 days of data. The Cisco default value is 30. You can also specify the time of day when the PM data will be saved by choosing the hour and minute from the Hour, Minutes, and AM/PM fields. Minutes are listed in 5-minute intervals. Check the Enable check box to activate the PM data pruning.

PM Data (1 day)

Specifies the number of days to save 1-day PM data before CTM runs the database pruning script. You can save from 1 to 1000 days of data. The Cisco default value is 30. You can also specify the time of day when the PM data will be saved by choosing the hour and minute from the Hour, Minutes, and AM/PM fields. Minutes are listed in 5-minute intervals. Check the Enable check box to activate the PM data pruning.

FM Data

Specifies the number of days to save fault management (FM) data before CTM runs the database pruning script. You can save from 1 to 1000 days of data. The Cisco default value is 7. You can also specify the time of day when the FM data will be saved by choosing the hour and minute from the Hour, Minutes, and AM/PM fields. Minutes are listed in 5-minute intervals. Check the Enable check box to activate the FM data pruning.

Audit Log Data

Specifies the number of days to save Audit Log data before CTM runs the database pruning script. You can save from 1 to 1000 days of data. The Cisco default value is 7. You can also specify the time of day when the Audit Log data will be saved by choosing the hour and minute from the Hour, Minutes, and AM/PM fields. Minutes are listed in 5-minute intervals. Check the Enable check box to activate the Audit Log data pruning.

Error Log Data

Specifies the number of days to save Error Log data before CTM runs the database pruning script. You can save from 1 to 1000 days of data. The Cisco default value is 7. You can also specify the time of day when the Error Log data will be saved by choosing the hour and minute from the Hour, Minutes, and AM/PM fields. Minutes are listed in 5-minute intervals. Check the Enable check box to activate the Error Log data pruning.

Audit Trail Data (for CTC-based NEs)

Specifies the number of days to save audit trail data before CTM runs the database pruning script. You can save from 1 to 1000 days of data. The Cisco default value is 7. You can also specify the time of day when the audit trail data will be saved by choosing the hour and minute from the Hour, Minutes, and AM/PM fields. Minutes are listed in 5-minute intervals. Check the Enable check box to activate the audit trail data pruning.

Self Monitor Data

Specifies the number of days to save self-monitoring data before CTM runs the database pruning script. You can save from 1 to 1000 days of data. The Cisco default value is 7. You can also specify the time of day when the self-monitoring data will be saved by choosing the hour and minute from the Hour, Minutes, and AM/PM fields. Minutes are listed in 5-minute intervals. Check the Enable check box to activate the self-monitoring data pruning.

Job Monitor Data

Specifies the number of days to save job monitoring data before CTM runs the database pruning script. You can save from 1 to 1000 days of data. The Cisco default value is 7. You can also specify the time of day when the job monitoring data will be saved by choosing the hour and minute from the Hour, Minutes, and AM/PM fields. Minutes are listed in 5-minute intervals. Check the Enable check box to activate the job monitoring data pruning.

Database Operations Tab

`sys' Password

The password for the sys user. The following are Cisco default passwords:

For the sys user: change_on_install

For the ctmanager: ctm123!

Backup Status

The state of the database hot backup. The Cisco default is Unknown.

Archive Log Pruning Parameters

Allows you to enable (default) or disable archive log pruning and configure pruning parameters. By default, when the archive log reaches 70% of capacity, pruning begins. The default location of the archive log backup directory is /ctm_backup.

Export status

The status of the database export process. The Cisco default is Unknown.

Start

Click the Start button to start exporting the database.


4.2.2  Backing Up the CTM Database from the CTM GUI

If your database is in ARCHIVELOG mode, you can perform a hot database backup or a database export. If your database is not installed in ARCHIVELOG mode, you can only perform a database export.

CTM uses the /ctm_backup directory as the default backup directory.

To perform a hot database backup, complete the following steps:


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

Step 2 Click Database Properties to open the Database Properties pane. Table 4-1 provides descriptions.

Step 3 Click the Database Operations tab.

Step 4 Enter the sys password in the `sys' Password field.

Step 5 Click Start.

The backup log file is saved to /oraclesw9i/admin/<ORACLE_SID>/udump/backup_db.log. The log file contains all of the files that have been backed up.


To perform a database export, complete the following steps:


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

Step 2 Click Database Properties to open the Database Properties pane. Table 4-1 provides descriptions.

Step 3 Click the Database Operations tab.

Step 4 In the Export area, click Start.

The file is exported to the /ctm_backup directory using the filename export_CTM<time_stamp>.dmp. The log file is named export_CTM.log.



Note It is recommended that you protect your data by backing it up regularly. Backups can be stored on a local or network-mounted, disk-based file system; on a local tape drive; or on a remote tape drive. Commercially available tools for Oracle and system-level backup include:

Legato Networker (or "Solstice Backup" when purchased from Sun Microsystems)

VERITAS NetBackup

BMC Software SQL Backtrack

GNU Oraback.sh


4.2.3  Backing Up the CTM Database from the CLI

CTM uses the /ctm_backup directory as the default backup directory.


Step 1 To perform a logical database backup (export) from the command-line interface (CLI), enter the following commands as the root user:


Note You can perform a logical database backup whether your database is running in ARCHIVELOG mode or in non-ARCHIVELOG mode.


cd /opt/CiscoTransportManagerServer/bin
./export_full_db.sh

The file is exported to the /ctm_backup directory using the filename export_CTM<time_stamp>.dmp. The log file is named export_CTM.log.

Step 2 To perform a full database hot backup, enter the following commands at the root user:


Note You can perform a hot database backup only if your database is running in ARCHIVELOG mode.


cd /opt/CiscoTransportManagerServer/bin
./backupdb.sh

The backup log file is saved to /oraclesw9i/admin/<ORACLE_SID>/udump/backup_db.log. The log file contains all of the files that have been backed up.


4.2.4  Restoring the CTM Database from the Previous Backup

To restore the CTM database, complete one of the following steps, depending on whether you want to restore the database from a hot database backup set or from an export.


Note The revert procedure will result in loss of local database information stored after the upgrade. In other words, a reverse database migration is not supported; rather, a backup copy of the original database is used.



Step 1 To restore the database from a hot backup, log into the CTM database workstation as the root user and enter the following commands:

cd /opt/CiscoTransportManagerServer/bin
./restore_db.sh <backup_file_location> <log_directory>


Note The default backup file location is /ctm_backup. The restore_db.sh script uses the latest backup to restore the database.


Step 2 To restore from an export dump file, complete the following substeps:

a. Disconnect all of the CTM clients and enter the following command to shut down the CTM server, if it is running:

ctms-stop

b. Enter the following commands to import the database:

cd /opt/CiscoTransportManagerServer/bin
./import_full_db.sh <backup_file_location> <export_dump_filename> <log_directory>


Note The default backup file location is /ctm_backup.



4.2.5  Pruning the CTM Database

This section describes how to set the time and date for automatic database pruning and how to use pruning scripts.

4.2.5.1  Setting the Time and Date for Automatic Pruning

Choosing to prune the database automatically prunes daily all PM data, FM data, Audit Log data, Error Log data, and audit trail data older than the specified retention period.


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

Step 2 In the Control Panel window, click Database Properties.

Step 3 In the Database Properties pane, click the Pruning tab.

Step 4 Check the Enable check box for each field as desired, and set the number of days and time of pruning.

Step 5 After making the selections, click Save. Changes take effect immediately.


4.2.5.2  Using Pruning Scripts

Aside from automatic pruning, you can also prune CTM data from the Oracle database at any given time by running database pruning scripts. Pruning scripts allow you to prune the following types of data:

Audit Log data

Audit trail data

Error Log data

FM data

All PM data

NEs and all related information

Self Monitor table data


Note For information about pruning NEs in a high availability environment, refer to the Cisco Transport Manager High Availability Installation Guide.



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

Step 2 Enter the following command to change to the CTM server bin directory:

cd /opt/CiscoTransportManagerServer/bin

Step 3 Enter the following command to see a list of pruning scripts:

ls -al prune*

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

For example, to prune Error Log data older than 25 days, enter the following command:

./prune_errlog.sh 25


The following table describes parameters that can be passed to the following scripts, and the tables that are affected:

Prune Audit Log data

Prune Error Log data

Prune FM data

Prune audit trail data

Prune Job Monitor table data

Prune Self Monitor table data

Table 4-2 Parameters for Database Pruning: Multiple Scripts 

Tables Affected
Input Parameters
Remarks
Prune Audit Log Data Script (prune_auditlog.sh)

transaction_log_table

Number of days (1-1000)

Removes all Transaction Log entries that were created before n days.

Prune Error Log Data Script (prune_errlog.sh)

error_log_table

Number of days (1-1000)

Removes all Error Log entries that were created before n days.

Prune FM Data Script (prune_fm.sh)

alarm_event_table

Number of days (1-1000)

Removes all alarm and event entries that were created before n days.

active_alarm_table

Number of days (1-1000)

Prune Audit Trail Data Script (prune_audittrail.sh)

ne_audit_trail_table

Number of days (1-1000)

Removes all NE audit trail entries that were created before n days.

PruneJob Monitor Table Script (prune_admin_job_table.sh)

admin_job_table

Number of days (1-1000)

Removes all job monitor entries that were created before n days.

Prune Self Monitor Table Script (prune_server_monitor.sh)

server_monitor_table

Number of days (1-1000)

Removes all self monitor entries that were created before n days.


Table 4-3 describes parameters that can be passed to the prune_pm.sh script, and the tables that are affected. The prune_PM.sh script removes all PM entries that were created before n days.


Note Based on the value of "Is 24 flag," CTM prunes 15-minute data, 1-day data, or both 15-minute and 1-day data. If the "Is 24 flag" value is blank, CTM prunes both 15-minute and 1-day data.


Table 4-3 Parameters for Database Pruning: Prune PM Data Script (prune_pm.sh) 

Tables Affected
Input Parameters

ONS15454_DS3_PM_TABLE

Number of days (1-1000)

Is 24 flag (where 0 = 15 min, 1 = 1 day, and 2 = both 15 min and 1 day)

ONS15454_SONET_PATH_PM_TABLE

ONS15454_SONET_LINE_PM_TABLE

ONS15454_SONET_SEC_PM_TABLE

ONS15454_ENET_PM_TABLE

ONS15454_DS1_PM_TABLE

ONS15454_Sonet_VT_PM_Table

ONS15454SDH_RS_PM_Table

ONS15454SDH_MS_PM_Table

ONS15454SDH_HO_PM_Table

ONS15454SDH_LO_PM_Table

ONS15454SDH_E1_PM_Table

ONS15454SDH_E3_PM_Table

ONS15454SDH_E4_PM_Table

ONS155XX_SONET_SEC_PM_TABLE

ONS155xx_Phy_PM_Table

ONS155xx_Opt_Power_PM_Table

ONS15501_Opt_Power_PM_Table

ONS155xx_CDL_PM_Table

ONS155xx_Ether_Hist_PM_Table

ONS155xx_FCM_PE_PM_Table

ONS158XX_IOC_W_PM_TABLE

ONS158XX_TRANSPONDER_PM_TABLE

ONS158XX_LSM_PM_TABLE

ONS158XX_SCF_PM_TABLE

ONS158XX_AMPLIFIER_PM_TABLE

ONS158XX_WD_PM_TABLE

ONS158XX_OADM_PM_TABLE

ONS158XX_WD_RX_PM_TABLE

ONS158XX_OSU_PM_TABLE

ONS158XX_BCS_PM_TABLE

ONS158XX_OAD_PM_TABLE

Number of days (1-1000)

Is 24 flag (where 0 = 15 min, 1 = 1 day, and 2 = both 15 min and 1 day)

ONS158XX_CMP_PM_TABLE

ONS15600_Sonet_Sec_PM_TABLE

ONS15600_Sonet_Line_PM_Table

ONS15600_Sonet_Path_PM_Table

ONS15454_PHY_LAYER_PM_Table

ONS15454_POS_PM_Table

ONS15454_OTN_SEC_PM_Table

ONS15454_OTN_PATH_PM_Table

ONS15454_OTN_FEC_PM_Table

ONS15600SDH_RS_PM_Table

ONS15600SDH_MS_PM_Table

ONS15600SDH_HO_PM_Table

ONS1530x_RS_PM_TABLE

ONS1530x_MS_PM_TABLE

ONS1530x_HO_PM_TABLE

ONS1530x_LO_PM_TABLE

ONS1530x_IP_PM_TABLE

HFR_INTERFACE_GC_PM_TABLE

HFR_INTERFACE_DRC_PM_TABLE

HFR_BGP_PEER_PM_TABLE

HFR_NODE_CPU_PM_TABLE

HFR_NODE_MEMORY_PM_TABLE

HFR_NODE_PROCESS_PM_TABLE

HFR_MPLS_TE_LINK_PM_TABLE

HFR_MPLS_TE_TUNNEL_PM_TABLE

HFR_MPLS_INTERFACE_PM_TABLE

HFR_MPLS_LDP_PM_TABLE


Table 4-4 describes parameters that can be passed to the prune_ne.sh script, and the tables that are affected. The prune_ne.sh script removes all information about the NE from the database. Use this script with extreme caution.


Caution Before running the script, shut down all CTM clients and the CTM server.

Table 4-4 Parameters for Database Pruning: Remove an NE Script (prune_ne.sh) 

Tables Affected
Input Parameters

ACTIVE_ALARM_TABLE

NE SYS ID

ADDITIONAL_DEVICE_INFO

ADMIN_JOB_TABLE

ALARM_COUNT_TABLE

ALARM_EVENT_TABLE

APS_GROUP_TABLE

AUDIT_LOG_TABLE

CERENT_NE_GROUP_TABLE

CIRCUIT_DEST_TBL

CIRCUIT_SPAN_TBL

CIRCUIT_TBL

CIRCUIT_VCG_TBL

CIRCUIT_VLAN_TBL

DOMAIN_TABLE

EQPT_INFO_TABLE

EQPT_RELATIONSHIP_TABLE

HFR_ACL_POLICY_CONFIG

HFR_BGP_PEER_PM_TABLE

HFR_COMMON_INTERFACE_CONFIG

HFR_ETHER_INTERFACE_CONFIG

HFR_INTERFACE_DRC_PM_TABLE

HFR_INTERFACE_GC_PM_TABLE

HFR_INTERFACE_HELPER_ADDRESS

HFR_INTERFACE_MTU_LAYER2

HFR_INTERFACE_SECONDARY_ADDR

HFR_MPLS_INTERFACE_PM_TABLE

HFR_MPLS_LDP_PM_TABLE

HFR_MPLS_TE_LINK_PM_TABLE

HFR_MPLS_TE_TUNNEL_PM_TABLE

HFR_NODE_CPU_PM_TABLE

HFR_NODE_MEMORY_PM_TABLE

HFR_NODE_PROCESS_PM_TABLE

HFR_POS_INTERFACE_CONFIG

HFR_SONET_INTERFACE_CONFIG

HFR_SONET_INTERFACE_PATH

HFR_VERSION_INFO

IF_CROSS_CONNECT

NE SYS ID

IF_DWDM_CHANNEL_GROUP

IF_OPTICAL_PHY_CONFIG_TABLE

INTERFACE_APS_INFO

INTERFACE_DWDM_FREQUENCY

INTERFACE_STACK_TABLE

MANAGED_ET_TAB

MAP_CUST_TABLE

MIB2_INTERFACE_TABLE

NE_AUDIT_TRAIL_TABLE

NE_INVENTORY_TABLE

NE_PORT_STATUS_TABLE

NE_SWIMAGE_TABLE

ONS15216_ACTIVE_USER_TABLE

ONS15216_NE_INVENTORY_TABLE

ONS15216_USER_TABLE

ONS1530X_HO_PM_TABLE

ONS1530X_IP_PM_TABLE

ONS1530X_LO_PM_TABLE

ONS1530X_MS_PM_TABLE

ONS1530X_NE_INVENTORY_TABLE

ONS1530X_RS_PM_TABLE

ONS15454SDH_E1_PM_TABLE

ONS15454SDH_E3_PM_TABLE

ONS15454SDH_E4_PM_TABLE

ONS15454SDH_HO_PM_TABLE

ONS15454SDH_LO_PM_TABLE

ONS15454SDH_MS_PM_TABLE

ONS15454SDH_RS_PM_TABLE

ONS15454_327_NE_TABLE

ONS15454_8B10B_PM_TABLE

ONS15454_ACTIVE_USER_TABLE

ONS15454_CBQOS_INFO_TABLE

ONS15454_CLASSMAP_PM_TABLE

ONS15454_COS_PM_TABLE

ONS15454_DS1_PM_TABLE

ONS15454_DS3_PM_TABLE

NE SYS ID

ONS15454_ENET_PM_TABLE

ONS15454_FC_PM_TABLE

ONS15454_IFX_PM_TABLE

ONS15454_MATCH_STMT_PM_TABLE

ONS15454_NE_INVENTORY_TABLE

ONS15454_OTN_FEC_PM_TABLE

ONS15454_OTN_PATH_PM_TABLE

ONS15454_OTN_SEC_PM_TABLE

ONS15454_PHY_LAYER_PM_TABLE

ONS15454_POLICE_PM_TABLE

ONS15454_POS_PM_TABLE

ONS15454_SONET_LINE_PM_TABLE

ONS15454_SONET_PATH_PM_TABLE

ONS15454_SONET_SEC_PM_TABLE

ONS15454_SONET_VT_PM_TABLE

ONS15454_USER_TABLE

ONS15501_NE_EXPLORER_TABLE

ONS15501_OPT_POWER_PM_TABLE

ONS155XX_CDL_FLOW_CONFIG

ONS155XX_CDL_IF_CONFIG

ONS155XX_CDL_PM_TABLE

ONS155XX_CIRCUIT_CC_TBL

ONS155XX_CIRCUIT_PATH_TBL

ONS155XX_DCRP_TABLE

ONS155XX_DCRP_TABLE

ONS155XX_DISCOVERY_INFO_TABLE

ONS155XX_ETHER_HIST_PM_TABLE

ONS155XX_FCM_PE_PM_TABLE

ONS155XX_FLASH_DEVICE_TABLE

ONS155XX_IF_CIRCUIT_PARAMS_TBL

ONS155XX_IF_OPTICAL_POWER

ONS155XX_IF_PHY_INFO_TABLE

ONS155XX_NE_INFO_TABLE

ONS155XX_OPT_POWER_PM_TABLE

ONS155XX_PHY_PM_TABLE

ONS155XX_SONET_SEC_PM_TABLE

NE SYS ID

ONS15600SDH_HO_PM_TABLE

ONS15600SDH_MS_PM_TABLE

ONS15600SDH_RS_PM_TABLE

ONS15600_ENET_PM_TABLE

ONS15600_POS_PM_TABLE

ONS15600_SONET_LINE_PM_TABLE

ONS15600_SONET_PATH_PM_TABLE

ONS15600_SONET_SEC_PM_TABLE

ONS158XX_AMPLIFIER_PM_TABLE

ONS158XX_BCS_PM_TABLE

ONS158XX_CMP_PM_TABLE

ONS158XX_IOC_W_PM_TABLE

ONS158XX_LAC_ACTIVE_USER_TABLE

ONS158XX_LAC_LOG_STATUS_TABLE

ONS158XX_LAC_LOG_TABLE

ONS158XX_LAC_USER_TABLE

ONS158XX_LSM_PM_TABLE

ONS158XX_NE_IP_TABLE

ONS158XX_OADM_PM_TABLE

ONS158XX_OAD_PM_TABLE

ONS158XX_OSU_PM_TABLE

ONS158XX_PM_ACT_MOD_TABLE

ONS158XX_SCF_PM_TABLE

ONS158XX_TIMESTAMP_PM_TABLE

ONS158XX_TRANSPONDER_PM_TABLE

ONS158XX_WD_PM_TABLE

ONS158XX_WD_RX_PM_TABLE

OSS_ALARM_FLTR_TID_DENY_TBL

PM_HISTORICAL_APPOINTMENTS

PROXY_SERVER_TABLE

SERVER_MONITOR_TABLE

SWAY_USER_PORT_TABLE

TCA_EVENT_TABLE

TRANSACTION_LOG_TABLE

UNMANAGED_NE_INVENTORY_TABLE

USER_MAP_TABLE

NE SYS ID

USER_MAP_TABLE_TEMP

CIRCUIT_DEST_TBL

CIRCUIT_SPAN_TBL

ONS155XX_GRANULAR_CC_TBL

ONS155XX_CIRCUIT_CC_TBL

ONS155XX_PATH_TBL

link_table

ne_info_table


4.2.5.3  Pruning Data for MGX Voice Gateway Devices

The /opt/svplus/scripts directory contains the following MGX-specific pruning scripts, which allow you to periodically remove files:

purge_pm_files.sh—Prunes all the PM-related statistics upload files periodically.

purge_audittral_files.sh—Prunes all the Audit Log-related files periodically.

The pruning parameters that you specify in the Control Panel are used to invoke these scripts automatically. See Setting the Time and Date for Automatic Pruning. You can also run these scripts manually, as follows:

To run the purge_pm_files.sh script manually, enter the following command:

/opt/svplus/scripts/purge_pm_files.sh <number>

For example, to prune PM data every 7 days, enter:

/opt/svplus/scripts/purge_pm_files.sh 7


Note When you run the purge_pm_files.sh script manually, only the files are removed. (The data in the database is removed by the prune_pm database procedure.)


To run the purge_audittrail_files.sh script manually, enter the following command:

/opt/svplus/scripts/purge_audittrail_files.sh <number>

For example, to prune Audit Log data every 7 days, enter:

/opt/svplus/scripts/purge_audittrail_files.sh 7

4.2.6  Using the SQL*PLUS Client to Manage the Database

To access the database and CTM schema objects, use the SQL*PLUS client that ships with Oracle products. The SQL*PLUS client is available for Microsoft Windows 2000 or NT 4.0 PCs or Sun Solaris 8 workstations. Refer to the Oracle documentation to install and run the SQL*PLUS client on a Windows 2000 or NT 4.0 PC.

On a Sun Solaris workstation, the SQL*PLUS client is installed as part of the Oracle server installation. The following guidelines are for logging into SQL*PLUS as a CTM user and managing CTM schema objects and data. Refer to Oracle's SQL*PLUS User's Guide and Reference for a complete description.


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


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


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

ORACLE_HOME

ORACLE_SID

PATH variable has $ORACLE_HOME/bin in the path

LD_LIBRARY_PATH

Step 3 On the command line, enter the following command:

sqlplus ctmanager/<password>


Note The default ctmanager password is ctm123!.


The message "Connected to: Oracle9i..." and the SQL> prompt should appear. If not, enter the username and password again.

Step 4 Enter any SQL command supported by Oracle upon connection to SQL*PLUS. For a list of SQL commands supported by Oracle, refer to the SQL*PLUS User Guide.


4.2.7  Understanding Basic SQL Commands for CTM Schema Objects

The following table lists commands that display, update, or modify CTM schema objects. Run each command in SQL*PLUS by entering the command at the SQL> prompt.

Table 4-5 SQL Commands for CTM Schema Objects 

SQL Command
Description

select * from user_tables;

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

select * from user_views;

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

describe ;

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

describe ;

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

select <col1, col2... coln> from <table_name>;

Takes col1....coln and table_name as parameters and displays data for all the columns listed. To display data for all columns, use an asterisk (*) instead of col1, col2, and so on.

select <col1, col2... coln> from <table_name> where <col1> = <value1> and <col2> = <value2>...


Takes col1...coln and table_name as parameters and displays data for all the columns listed that meet the condition specified in the "where" clause. For example, the command:

select nedbaccessid from ne_info_table where nesysid = 'ANGEL';


returns the value of column nedbaccessid from table ne_info_table for all rows for which nesysid = ANGEL.

select <col1, col2... coln> from <view_name> where <col1> = <value1> and <col2> = <value2>...

Takes col1...coln and view_name as parameters and displays data for all the columns listed that meet the condition specified in the "where" clause.

delete <table_name>;

Takes table_name as a parameter and deletes the entire contents of the table. To make the change permanent, enter commit; at the SQL> prompt.


4.3  How Do I Manage the Network Software?

This section contains the following information:

Managing Binaries Using the CTC Upgrade Table

Software Management

Managing Cisco IOS-XR Software Packages

Using the Flash File Table

Viewing Software Versions and Restarting the NE with a New Software Image

Transferring Images

Adding a New NE Software Version to the CTM Domain

Deleting an NE Software Version from the CTM Domain

Follow the procedures described in this section to upgrade the Cisco Transport Controller (CTC) binary file and download new or modified images to supported NEs.

4.3.1  Managing Binaries Using the CTC Upgrade Table

Use the CTC Upgrade table to upgrade CTC binaries to the CTM database, to see which binary versions are available on the server, to make a particular CTC binary the active binary, or to delete a CTC binary.

The following table describes the fields in the CTC Upgrade table.

Table 4-6 Field Descriptions for the CTC Upgrade Table 

Column Name
Description

Active

Indicates whether the selected CTC binary is the active binary.

Filename

Displays the filename of the binary that was uploaded to the CTM server.

Date and Time

Displays the date and time when the binary was uploaded to the CTM server.

User

Displays the username of the user who uploaded the binary to the CTM server.


4.3.1.1  Upgrading the CTC Binary File

If you have user privileges to do so, you can upgrade the CTC binary file independently of other CTM product upgrades.


Note If an updated CTC image becomes available after CTM is released, it is made available online to registered CCO users.



Caution The NE software packages (*.pkg files) for CTC are not the same as the NE software package (*.pkg files) used by the CTM client.


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

Step 2 Click the Add CTC Binary tool (or choose Edit > Add) to open the Upload CTC Binary File dialog box.

Step 3 In the Upload CTC Binary File dialog box, enter the complete name of the CTC package file to upload. Alternatively, click Browse to browse for a particular file. To make the upgraded CTC binary file the active file, check the Activate check box.

Step 4 Click OK. The CTC binary file appears in the CTC Upgrade table.

Step 5 If the binary file was not activated in Step 3, activate it now. Click the Activate CTC Binary tool (or choose Edit > Activate).


Note The CTM client synchronizes its local CTC files the next time it logs into the CTM server. Depending on the bandwidth available between the server and the client, the synchronization might take a few minutes to complete.



4.3.1.2  Deleting the CTC Binary File


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

Step 2 Select a CTC binary file to delete; then, click the Delete CTC Binary tool (or choose Edit > Delete).

Step 3 Click OK in the confirmation dialog box.


4.3.2  Software Management

Use the Software Management Wizard to download software images to the following NEs:

ONS 15216 EDFA2 (R2.3.0 and later)

ONS 15216 EDFA3

ONS 15302

ONS 15305

ONS 15310 CL

ONS 15310 MA

ONS 15327

ONS 15454 SONET

ONS 15454 SDH

ONS 15501

ONS 15530

ONS 15540 ESP

ONS 15540 ESPx

ONS 15600 SONET

ONS 15600 SDH

ONS 15800

ONS 15801

ONS 15808

Cisco MGX Voice Gateway

Follow the procedures described in this section to download new or modified images to NEs.


Caution Before updating the software image on an NE, check the CTM release notes to verify whether the NE software release is supported by CTM. See the "CTM-Supported Network Element Software Releases" table in the release notes at http://www.cisco.com/univercd/cc/td/doc/product/rtrmgmt/optnet/ctm/index.htm.


Note If a software download has a status of Queued, and if it has a task in the running list, the download cannot be canceled.



Caution If you mark an NE as an Out of Service while a software download is in progress on that NE, the software download might not complete successfully.


Caution To download software images to NEs, it is recommended that the data communications network (DCN) bandwidth be 56 kbps or higher. If DCN bandwidth is less than 56 kbps, software download might take an extended period of time. For example, a typical ONS 15327 software image is approximately 2.5 MB. If a 2.5-MB file is downloaded to a single NE over a 19.2-kbps link, it will take 15 to 30 minutes depending on the volume of traffic. Performing software downloads in parallel increases the length of time by a multiple of the number of NEs targeted.


Note The latest ONS 15216 EDFA2 R2.4 hardware does not support software download to a software release other than 2.4.0. The ONS 15216 EDFA2 R2.3 hardware supports software download for NE software releases 2.3 and 2.4.



Note For the ONS 15305 R2.0, a software download performed through CTM downloads only the agent software, not the entire network release. To download network release software, you must use Cisco Edge Craft.



Note The ONS 15800, ONS 15801, and ONS 15808 support software download of TL1 agent images. For firmware upgrade, see Cisco Photonics Local Terminal Software Administrator Manual for the ONS 1580x System.



Note For MGX devices, CTM provides a mechanism to download software images from the CTM server to the MGX switch. When the software download is scheduled, an FTP connection is opened to the switch using the IP address, user ID, and password. The software image is downloaded to the /opt/CiscoTransportManagerServer/images/Cisco_MGX_Voice_Gateway directory. The FTP connection is closed and  MGX processes resume.

When the software image is downloaded, you can use the following commands at the CLI:

dsprev to display the image on the MGX switch

loadrev to load the image on the MGX switch

setrev to set the image on the MGX switch

runrev command to activate the image on the MGX switch



Note Refer to the appropriate NE documentation for precautions and guidelines before performing an NE software upgrade. Following is a list of Cisco NE documentation on upgrading CTC-based nodes:

Upgrading Cisco ONS 15310 CL Release 5.0 to 6.0

Upgrading Cisco ONS 15327 Release 4.x to 6.0

Upgrading Cisco ONS 15454 Release 4.x to 6.0

Upgrading Cisco ONS 15454 SDH Release 4.x to 6.0

Upgrading Cisco ONS 15600 Release 1.x to R5.0


4.3.2.1  Downloading Software Images to ONS 15216, ONS 153xx, ONS 15454, ONS 15501, ONS 15600, ONS 1580x, and MGX NEs


Step 1 In the Domain Explorer tree, select a management domain or group that contains NEs that are assigned an In Service or Under Maintenance operational state. Alternatively, select an NE that is assigned an In Service or Under Maintenance state.


Note Only one software download can occur on a specific NE at any given time.


Step 2 Choose Administration > Software Management > Optical/MGX. The Software Management wizard opens. Table 4-7 provides descriptions.

Step 3 Enter the following information:

NE model

NEs

Source

Job comments

Time


Caution If the CTM client and server run on the same machine and thus the local source directory is the same as the default destination directory, an error message is generated. To retrieve the software image selected from the local source directory, navigate to the appropriate path and restore it from the <software_image_name>.old file.

Step 4 (For non-ONS 15501 NEs) Click Finish to initiate the software download to the standby memory on the NE.

Step 5 (For ONS 15501 NEs) Click Next.

Step 6 To activate the new image automatically, select Reboot and Activate. If Reboot and Activate is selected, the NE is rebooted with the newly downloaded image. If Reboot and Activate is not selected, you can activate the image later from the Flash File table. (See Using the Flash File Table.)

Step 7 Select the following information:

NEs

Flash banks


Note To view information about the files stored in the Flash bank of the NE, click Flash File Table at the bottom of the wizard. The Flash File table shows the Flash bank names and the name and status for each stored file. For more information about the Flash File table, see Using the Flash File Table.



Note The currently active Flash bank is unavailable; users cannot download to the active Flash bank.


Step 8 Click Finish. The image will be downloaded to all of the NEs in the Selected Downloads list.

CTM stores two software versions: active and standby. When you download software, it is saved as the standby version. To activate the software download, use the NE Software table. (See Viewing Software Versions and Restarting the NE with a New Software Image.)


Note When you perform a software download on the ONS 15302, the node is restarted immediately with the new downloaded software. The result of the operation is sent to the Job Monitor table. In the NE Software table, the Switch/Revert operation is not allowed for the ONS 15302. The Commit operation, which is supported for the ONS 15302 R2.0 and later, switches to the standby software on the NE. The current standby software is not displayed for the ONS 15302.


Step 9 To check the status of the download job or verify that the download job was successful:

a. Check the Job Monitor table (Administration > Job Monitor).

b. Select the NE and check the Software Version field of the Equipment Inventory table (Configuration > <NE_model> > Equipment Inventory Table).

c. Select the NE and check the Active Software Filename field in the NE Software table (Administration > NE Software Table) for the software image version.



Note To download software to an ONS 15216 EDFA3 NE using the Server option, first choose Administration > Image Transfer. The Image Transfer dialog box opens. The image will be copied from the local file system in the directory specified in the CTM Server area. Choose Cisco ONS 15216 EDFA3 from the pull-down menu; then, click Upload. Then, choose Administration > Software Management > Optical/MGX. The Software Management Wizard opens with the Server radio button enabled.


Table 4-7 Field Descriptions for the Software Management Wizard 

Field
Description

NE Model

Select the NE type to which you want to download software. The type you select determines the NEs that are displayed under Network Elements.

Network Elements

Use the Add and Remove buttons to move NEs to the Selected NEs list or remove NEs from the list. Software will be downloaded to NEs in the Selected NEs list.

Source

Specify the location of the software:

Local allows you to select an image on the current client system.

Server allows you to select an image on the CTM server to which your client is connected. The Server radio button is not active unless an image file exists on the server.


Caution Do not select the Server option for ONS 1580x NEs.

Remote allows you to select an image on another network server that has TFTP or FTP configured and running. Specify the IP address of the server and the fully qualified pathname of the image, relative to the tftpboot directory. Remote is the only selectable source option for the following NEs: ONS 15302, ONS 15305, ONS 15800, ONS 15801, and ONS 15808.

Note If the Remote TFTP Server option is selected for ONS 15216 EDFA2, the software image that you are downloading must have been saved in the default directory, such as the tftpboot directory on the remote TFTP server.

Note The tftpboot directory must have read-write access, or the software download will fail. See Chapter 3, "Building the Network" for information about how to configure the tftp directory with read-write access.

Job Comments

Enter comments about the software download.

Time (time zone)

Set a time for the download. Click Now to begin downloading immediately, or click At Time and specify when to begin downloading, in 5-minute increments.

Note The time zone can be GMT, a user-defined offset from GMT, or local time, depending on what is specified in the User Preferences dialog box.

Software Download Pane 2 for ONS 15501 NEs

Download Options For All Selected NEs

Reboot and Activate—Activates the new software image and reboots the NE, so the new image takes effect immediately.

Select Flash Partition

Selected NEs—NEs that will receive downloaded software.

Select Flash Bank—The Flash bank available for storing the downloaded image on the selected NE.

Selected Downloads

The NEs selected for image download and the Flash bank you selected for each NE.

To see details on the Flash bank, select an NE and click Flash File Table.

Software Download Pane 2 for ONS 15530 and ONS 15540 NEs

Image File Size

The size of the image file. If you are downloading from a remote TFTP server, the size of the image file is not available.

Cancel job if CPU state changes

Cancel the job if the CPU state changes between the time the job is scheduled and the time the job is executed.

Activate image on next reload

Activates the image the next time the NE is rebooted.

Reload

Reboots the NE right after activation so the new image takes effect immediately. If an active CPU is reloaded, this option will cause a switchover if a standby CPU is present. Otherwise, service might be disrupted until the CPU reboots.

Switchover after downloading and reloading standby

(Available only when you choose the "Activate image on next reload" and "Reload" options.) This option applies only when downloading to the standby CPU. Switchover to standby occurs after downloading to and reloading the standby CPU; the standby CPU becomes active and runs the newly downloaded image.

Selected NEs

NEs that will receive downloaded software. When you select an NE from this list, information about the available flash partitions on the NE is displayed in the Flash Partition Data area, and you can select a partition.

Flash Partition Data

The flash partitions available for storing the downloaded image on the selected NE:

CPU Slot No—Slot number of the CPU that contains the flash device.

Status—Status of the CPU (active or standby).

Name—Name of the flash partition; partitions on the standby CPU are indicated by "sby."

Total Size—Total size of the partition, in bytes.

Available—Number of free bytes in the partition. If you select a partition that does not have enough space to store the image, a warning message is displayed.

Selected Downloads

The NEs selected for image download and the Flash bank you selected for each NE.

To see details about flash memory, select an NE and click Flash File Table.

To remove an NE from the Selected Downloads list, select the NE and click Drop.


4.3.2.2  Downloading Software Images for ONS 15530 and ONS 15540 NEs

This section contains procedures for:

Downloading Software Images on Single-CPU NEs

Downloading Software Images for Dual-CPU NEs


Note Table 4-7 describes the fields in the Software Management Wizard.



Note Before downloading software on an ONS 155xx NE, verify that a read-write community string is available for the NE in the ONS 155xx SNMP Settings table. If there is no read-write community string available, the software download will fail with a "No write access" or "Request timed out" error message.


4.3.2.2.1  Downloading Software Images on Single-CPU NEs


Step 1 In the Domain Explorer tree, select one of the following:

A management domain or group that contains ONS 15530 or ONS 15540 NEs that are in service or under maintenance.

An ONS 15530 or ONS 15540 NE that is in service or under maintenance.

Step 2 Choose Administration > Software Management > Optical/MGX. The Software Management Wizard opens. Enter the following information:

NE model

NEs

Source

Job comments

Time


Note The Server radio button is not active unless the relevant subdirectory in the /$CTMHOME/images/ directory contains an image file. The subdirectories are named Cisco_ONS15530, Cisco_ONS_15540_ESP, and Cisco_ONS_15540ESPx.



Caution If the CTM client and server run on the same machine and thus the local source directory is the same as the default destination directory, an error message is generated. To retrieve the software image selected from the local source directory, navigate to the appropriate path and restore it from the <software_image_name>.old file.

Step 3 Click Next.

Step 4 Use the Image File Size field to determine which Flash partition has enough free space to hold the image.

Step 5 Select desired image download options.

Step 6 Select the following information:

NEs

Flash banks (ONS 15501 only)

Flash partitions


Note For the ONS 15501, click Flash File Table at the bottom of the wizard to view information about the files stored in the Flash bank of the NE. The Flash File table shows the Flash bank names and the name and status for each stored file. For more information about the Flash File table, see Using the Flash File Table.



Note For the ONS 15501, the currently active Flash bank is unavailable; you cannot download to the active Flash bank.



Note If a Flash partition is selected before displaying the Flash File table, information is shown about the files on that partition only.


Step 7 Click Finish. Downloads will be performed for all the NEs in the Selected Downloads list.


Note If a partition that has insufficient space is selected, a warning message appears when the Finish button is clicked. Decide whether or not to proceed with the download. This check for free space is not performed for the remote server option.


After validating the image, the CTM server transfers the image to the selected Flash partition through TFTP. When the transfer is completed, the configuration register value is set to 0x02 for automatic booting and the boot command is modified to put the downloaded image first on the list.

If the reload option is selected, the NE is rebooted with the newly downloaded image.

If the image option is activated, the new software image is activated. If this option is not selected, activate the image from the Flash File table. (See Using the Flash File Table.)

Step 8 To check the status of the download job or verify that the download job was successful:

a. Check the Job Monitor table (Administration > Job Monitor).

b. Select the NE and check the Software Version field of the Equipment Inventory table (Configuration > ONS 155XX > Equipment Inventory Table).

c. Select the NE and check the Active Software Filename field in the NE Software table (Administration > NE Software Table) for the software image version.


4.3.2.2.2  Downloading Software Images for Dual-CPU NEs

Consider the following recommendations when downloading software images for dual CPUs:

Update the standby CPU first and choose the switchover option. This ensures that the new image will run on an active CPU with minimum system interruption.

Either update the second CPU immediately after updating the first one, or schedule the second CPU for downloading after the image has run successfully for some time on the first CPU.


Step 1 In the Domain Explorer tree, select one of the following:

A management domain or group that contains ONS 15530 or ONS 15540 NEs that are in service or under maintenance.

An NE that is in service or under maintenance.

Step 2 Select Administration > Software Management > Optical/MGX. The Software Management Wizard opens. Enter the following information:

NE model

NEs

Job comments

Source

Time


Note The Server radio button is not active unless the relevant subdirectory in the /$CTMHOME/images/ directory contains an image file. The subdirectories are named Cisco_ONS15530, Cisco_ONS_15540_ESP, and Cisco_ONS_15540ESPx.



Caution If the CTM client and server run on the same machine and thus the local source directory is the same as the default destination directory, an error message is generated. To retrieve the software image selected from the local source directory, navigate to the appropriate path and restore it from the <software_image_name>.old file.

Step 3 Click Next.

Step 4 Check the Image File Size field against the list of Flash partitions to determine which Flash partition has enough free space to hold the image.

Step 5 Select desired image download options.


Note Before the image is activated, the CTM server checks the state of the standby CPU. If the standby CPU is not in hot-standby mode, the update operation is aborted after the image is downloaded. For more information, refer to the hardware documentation for information about updating with system images that are not hot-standby compatible.



Note If the "Switchover after downloading and reloading standby" option is selected, the image will always be downloaded to the selected CPU slot number. For example, assume that slot 6 is standby and the sby-bootflash (standby) partition is chosen. If a switchover occurs between job scheduling and job execution and slot 6 becomes active, the image will be downloaded to the slot 6 bootflash partition.


Step 6 Select the following information:

NEs

Flash banks (ONS 15501 only)

For the ONS 15501, the currently active Flash bank is unavailable; you cannot download to the active Flash bank.

Also, for the ONS 15501, click Flash File Table at the bottom of the wizard to view information about the files stored in the Flash bank of the NE. The Flash File table is displayed, showing the Flash bank names and the name and status for each stored file. For more information about the Flash File table, see Using the Flash File Table.

Flash partitions

If a Flash partition is selected before displaying the Flash File table, information is shown about the files on that partition only.

Step 7 Click Finish. Downloads will be performed for all the NEs in the Selected Downloads list.


Note If a partition that has insufficient free space is selected, a warning message appears. Decide whether or not to proceed with the download. This check for free space is not performed for the remote server option.


After validating the image, the CTM server transfers the image to the selected Flash partition through TFTP. When the transfer is completed and the standby CPU is in hot standby mode, the configuration register value is set to 0x02 for automatic booting and the boot command is modified to put the downloaded image first on the list. If the reload option is chosen, the standby CPU is reloaded.

If the switchover option is selected, a switchover from the active CPU to the standby CPU is performed after reloading the standby CPU. The former standby CPU, which is now the active CPU, will run the newly downloaded image.

If the Activate option is not selected, activate the new image from the Flash File table. (See Using the Flash File Table.)

Step 8 After updating the standby CPU (which is now the active CPU), use the same procedure to update the formerly active CPU (which is now the standby CPU), with one difference: there is no need to select the switchover option because the current active CPU is already running the new image.

Step 9 To check the status of the download job or verify that the download job was successful:

a. Check the Job Monitor table (Administration > Job Monitor).

b. Select the NE and check the Software Version field of the Equipment Inventory table (Configuration > ONS 155XX > Equipment Inventory Table).

c. Select the NE and check the Active Software Filename field in the NE Software table (Administration > NE Software Table) for the software image version.


4.3.3  Managing Cisco IOS-XR Software Packages

Use the IOS-XR Software Package Management wizard to manage software packages for CRS-1 and XR 12000 NEs.

A software package is a collection of related Cisco IOS-XR software components. Packages are used for Cisco IOS-XR source code management, builds, software upgrades, and testing.

For source code management and builds, a package contains the build infrastructure describing how to build the package, source code for the interfaces and implementations of the binary objects in the package, and metadata describing the interfaces and exports from the package.

For software upgrades and testing, a package consists of the set of binary files exported by the constituent Cisco IOS-XR software components, as well as the corresponding metadata from the software components.

A Package Installation Envelope (PIE) is the file format used to ship all software changes to Cisco IOS-XR routers. This includes package upgrades, Software Maintenance Units (SMUs), composite PIEs, and component PIEs. PIE files are used for all software delivery to the router, except for the first software installation made to a newly manufactured router. That initial software delivery is conducted by means of a bootable VM file.


Note PIE files are not bootable and must always be installed on a router that is already running.


By default, CTM provides best-effort software package management for different tasks in an operation. If you select multiple NEs and a task fails on one NE, other tasks are still carried out on the other NEs. However, if one operation fails on one NE, subsequent operations in that task are not attempted.

You can perform software management operations on multiple NEs of the same type in a single job. Each job consists of multiple tasks for each NE package. The TFTP server on the CTM server workstation is used to transfer software packages to the NE. The CLI is used to invoke the software management operations.


Step 1 In the Domain Explorer tree, select a management domain or group that contains CRS-1 or XR 12000 NEs that are assigned an In Service or Under Maintenance operational state. Alternately, select a CRS-1 or XR 12000 that is assigned an In Service or Under Maintenance state.

Step 2 Choose Administration > Software Management > IOS-XR. The IOS-XR Software Package Management wizard opens. Table 4-8 provides descriptions.

Step 3 In the Network Elements area, use the Add button to move NE(s) to the Selected NEs list. The software management operation applies to the NEs in the Selected NEs list.

Step 4 In the Operations area, specify the type of operation that you want to perform:

Add—Adds a software package to the router. CTM allows you to install, activate, and commit the software package in a single job.

Remove—Removes a deactivated package. CTM allows you to remove an active package by deactivating it first. You can commit the changes in a single job.

Activate—Activates a software package that is already installed.

Commit—Commits the active packages for the current load path and saves the location of the packages.

Deactivate—Deactivates a software package that is already installed.

Rollback—Rolls back to the last committed installation point.

Step 5 Click Next. Subsequent panes and fields depend on software operation selected.

Step 6 Specify your selections in the wizard. Move through the wizard panes by clicking Next. Apply your changes in a given pane by clicking Save Selection. When you reach the last pane, click Finish.


Table 4-8 Field Descriptions for the IOS-XR Software Package Management Wizard 

Field
Description

Network Elements

Use the Add and Remove buttons to move NEs to the Selected NEs list or remove NEs from the list. The software management operation applies to the NEs in the Selected NEs list.

Operations

Select the software management operation that you want to perform:

Add—Adds a software package to the router. CTM allows you to install, activate, and commit the software package in a single job.

Remove—Removes a deactivated package. CTM allows you to remove an active package by deactivating it first. You can commit the changes in a single job.

Activate—Activates a software package that is already installed.

Commit—Commits the active packages for the current load path and saves the location of the packages.

Deactivate—Deactivates a software package that is already installed.

Rollback—Rolls back to the last committed installation point.

Software Add Pane

Select NE

From the drop-down list, select the NE on which to add software.

Select Source Files

Specify the source file:

Click Local and browse to the directory where the packages are located. Selected files are listed in the Available PIE/SMU Files list.

Click Server and specify the directory on the server where the packages are located. All the files in the CiscoTransportManagerServer/images/Cisco_IOSXR folder are displayed.

Select PIE/SMU Files

Review the available and selected PIE/SMU files. Use the Add and Remove buttons to move files to the Selected PIE/SMU Files list or remove files from the list. The software add operation applies to the files in the Selected PIE/SMU Files list.

Save Selection

After specifying your selections in the Software Add pane, click Save Selection. A PIE integrity check is conducted to validate the PIE, and any inconsistencies are reported. The table is then populated with your selections. You can then choose another NE in the Select NE drop-down list and repeat your selections.

Note If the file being uploaded is already present on the server, you are prompted to overwrite the file.

Delete Row

Select a row in the table and click Delete Row to remove it.

Activate all PIE/SMU on all locations

Check this check box to activate the packages being installed.

Software Remove Pane

Select NE

From the drop-down list, select the NE from which to remove software.

Remove Active Packages

If checked, the Available Package/SMU list displays active and inactive packages. If unchecked, only inactive packages are listed.

Note If you check the Remove Active Packages check box, select some active packages for deletion, and later uncheck this check box, the active packages are removed from the Selected Package/SMU list.

Select Package/SMU

Review the available and selected packages. Use the Add and Remove buttons to move packages to the Selected Package/SMU list or remove packages from the list. The Selected Package/SMU list shows the software packages that will be removed from the selected NE.

Save Selection

After specifying your selections in the Software Remove pane, click Save Selection. The table is populated with your selections. You can then choose another NE in the Select NE drop-down list and repeat your selections.

Delete Row

Select a row in the table and click Delete Row to remove it.

Software Activate Pane

Select NE

From the drop-down list, select the NE on which to activate software packages. The list of packages that can be activated is retrieved from the router and includes the list of all installed and deactivated packages.

Select Package/SMU

Choose the package from the drop-down list.

Activate all supported locations

Check this check box to activate the package on all locations. When this check box is checked, the physical location selection is disabled.

Physical Location list

The Physical Location list shows the locations where the package will be activated.

Save Selection

After specifying your selections in the Software Activate pane, click Save Selection. The table is populated with your selections. You can then choose another NE in the Select NE drop-down list and repeat your selections.

Note You are notified with an error message if you try to install a PIE that requires another package to be installed already.

Delete Row

Select a row in the table and click Delete Row to remove it.

Software Commit Pane

Commit

When you select Commit and click Next, you are taken to the Software Schedule pane, where you can schedule the software commit for the selected NE(s).

Time (time zone)

Set a time for the commit operation. Click Now to begin the commit immediately, or click At Time and specify when to begin the commit, in 5-minute increments.

Note The time zone can be GMT, a user-defined offset from GMT, or local time, depending on what is specified in the User Preferences dialog box.

Comments

(Optional) Enter comments about the commit operation.

Software Deactivate Pane

Select NE

From the drop-down list, select the NE on which to deactivate software packages.

Select Package/SMU

Choose the package from the drop-down list.

Deactivate all supported locations

Check this check box to activate the package on all locations. When this check box is checked, the physical location selection is disabled.

Physical Location list

The Physical Location list shows the locations where the package will be activated.

Save Selection

After specifying your selections in the Software Deactivate pane, click Save Selection. The table is populated with your selections. You can then choose another NE in the Select NE drop-down list and repeat your selections.

Delete Row

Select a row in the table and click Delete Row to remove it.

Software Rollback Pane

Select NE

From the drop-down list, select the NE on which to roll back software.

Specify Rollback Point

Select the ID of the install point to roll back to. The details of the selected rollback point are shown in the Rollback Point Information field.

Rollback Point Information

Shows detailed information about the selected rollback point.

Reload affected nodes as part of rollback

If a reload (equivalent to a reboot) is required for a rollback, this check box allows the job to continue with a reload and succeed. Otherwise, the operation on the router will fail and you will be prompted to check the reload check box.

If the rollback operation can be performed without a reload, this check box has no effect.

Based on the set of packages being activated and deactivated as part of the rollback, one or more nodes can be reloaded. If the rollback point is more than two operations away, you must check the "Reload affected nodes as part of rollback" check box, which causes the router to be reloaded.

Save Selection

After specifying your selections in the Software Rollback pane, click Save Selection. The table is populated with your selections. Only one row is available for each NE. If you select a different rollback point and click Save Selection, a warning message prompts you that the existing table contents will be overwritten. Based on your response, the existing table contents are retained or overwritten.

Delete Row

Select a row in the table and click Delete Row to remove it.

Software Schedule Pane

Time (time zone)

Set a time for the software management operation. Click Now to begin the operation immediately, or click At Time and specify when to begin the operation, in 5-minute increments.

Note The time zone can be GMT, a user-defined offset from GMT, or local time, depending on what is specified in the User Preferences dialog box.

Test Now

If checked, no changes are made on the NE, but CTM conducts a trial test and reports in the Job Monitor table whether the operation will succeed or fail.

When you check the Test Now check box, the commands corresponding to the selections you have made are executed on the NE in test mode. The test option allows you to view the results of the operation without impacting the router. With test mode, the job begins immediately.

Install Commit

If checked, changes are committed on the router. The commit succeeds only if CTM has connectivity to the NE and Telnet is enabled.

Comments

(Optional) Enter comments about the software management operation.


4.3.4  Using the Flash File Table

Use the Flash File table to activate a downloaded image and manipulate the files in the ONS 155xx NE Flash memory.


Step 1 From the Domain Explorer, select an NE; then, select Administration > ONS 155XX > Flash File Table. The following table describes the fields in the Flash File table.

Step 2 Perform any of the functions listed in Table 4-10.


Table 4-9 Field Descriptions for the Flash File Table 

Column Name
Description

Flash Partition Name

Name of the flash partition that contains the flash file.

Filename

Name of the flash file.

File Status

Status of the flash file:

Deleted: The file is marked as deleted.

Invalid Checksum: The file has an invalid checksum.

Valid: The file is valid.

Active: (ONS 15501 only) The software in the file has been activated.

Not active: (ONS 15501 only) The software in the file has not been activated.

File Size

Size of the file in bytes. This field is not applicable to the ONS 15501; the file size cannot be read.

File Checksum

File checksum stored in the file header. The checksum is computed and stored when the file is written into the flash partition and serves to validate the data in the file. A file is marked as having an invalid checksum if any checksum mismatch was detected while writing or reading the file.

Incomplete files (files truncated because of either a lack of free space or a network download failure) are also written with a bad checksum and marked as invalid.

This field is not applicable to the ONS 15501; the checksum cannot be read.


Table 4-10 Flash File Table Functions and Supported ONS 15501, ONS 15530, and ONS 15540 NEs 

Function
Procedure
Supported on ONS 15501?
Supported on ONS 15530?
Supported on ONS 15540 ESP and ONS 15540 ESPx?

Activate an image

Select the file and choose Edit > Activate. The image is activated, and the NE reboots.

Yes

Yes

Yes

Verify file checksum

Select the file and choose Edit > Verify.

No

Yes

Yes

Mark a file as deleted

Select the file and choose Edit > Delete. The status of the file changes to Deleted. The file is not actually deleted until the Squeeze function is used.

No

Yes

Yes

Mark a file as undeleted

Select a file that is marked Deleted and choose Edit > Undelete.

No

Yes

Yes

Physically remove a file

Select a file that is marked Deleted and choose Edit > Squeeze.

No

Yes

Yes


4.3.5  Viewing Software Versions and Restarting the NE with a New Software Image

The NE Software table lists the software that is installed on an NE. Use the Edit menu options to restart an NE with a new software image.


Tip Back up the NE database before activating or reverting to the standby software image on the NE.



Note The Edit menu options are not available for the CRS-1 or XR 12000 NEs. The NE Software table is not supported for the Catalyst 6509.



Step 1 In the Domain Explorer tree, select an NE and choose Administration > NE Software Table. Table 4-11 describes the fields in the NE Software table.

For NEs other than the ONS 15216 EDFA and ONS 1580x, the NE Software table displays the active and standby software versions for the NE.

For ONS 15216 EDFA and ONS 1580x NEs, the NE Software table displays the active, standby, and running software versions.


Note The NE Software table can also be launched from the Job Monitor table. From the Job Monitor table, choose Edit > NE Software Table.


Step 2 To activate new software on an NE, select the NE in the table and click the Commit tool (or choose Edit > Commit).

For CTC-based NEs, this makes the standby software version the active version (if the standby version is newer than the active version) and restarts the NE with the newer version.

For the ONS 15800, ONS 15801, and ONS 15808, the running software version can assume the active or standby software version.


Note The Commit feature is not available for ONS 15216 EDFA NEs.


Step 3 To revert to the standby software version on an NE, select the NE and click the Revert/Switch tool (or choose Edit > Revert/Switch).

For the ONS 15216 EDFA, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SONET, and ONS 15454 SDH, this reverts the active software version back to the standby version (if the standby version is older than the active version) and restarts the NE with the newer version.

For the ONS 15600 SONET and ONS 15600 SDH, the Revert operation opens the Memory Restore dialog box, and you will need to provide a compatible database. For example, if the NE is running a software release 1.1 and you want to download a release 1.0 package, you must provide a release 1.0 database after downloading the software release 1.0 package.

For the ONS 15800, ONS 15801, and ONS 15808, the Revert/Switch operation makes the standby software version the running version.

Step 4 To accept the software version of an NE, select the NE and click the Accept tool (or choose Edit > Accept). The Accept command copies the downloaded software onto the standby Timing & Shelf Controller (TSC) and activates it.


Note The Accept feature is only available for the ONS 15600 SONET and ONS 15600 SDH.



Table 4-11 Field Descriptions for the NE Software Table 

Field
Description

NE Model Name

Displays the model of the selected NE.

Alias ID

Alias name of the NE.

NE ID

Displays the ID name of the selected NE.

Physical Location

Displays the location where the software is running.

Active Software

Displays the active software version. For the ONS 15530 and ONS 15540, displays the software version on the active CPU.

Standby Software

Displays the standby software version. For the ONS 15302 and ONS 15305, it is the NE software version that has been downloaded. For the ONS 15530 and ONS 15540, displays the software version on the standby processor if a standby processor is present.

Running Software

(ONS 1580x only) Displays the running software version.

Busy Flag

Indicates whether the NE is rebooting to perform a software commit or revert. While the NE is rebooting, the value is true; when the NE has finished rebooting, the value is false.


4.3.6  Transferring Images

You can transfer NE binary software images from the client file system into an appropriate NE software repository in the CTM server, to make the images available for selection when requesting a software download.

Use the Image Transfer dialog box to transfer software images to the following NEs:

ONS 15216 EDFA2

ONS 15216 EDFA3

ONS 15302

ONS 15305

ONS 15310 CL

ONS 15310 MA

ONS 15327

ONS 15454 SONET

ONS 15454 SDH

ONS 15501

ONS 15530

ONS 15540 ESP and ESPx

ONS 15600 SONET

ONS 15600 SDH

ONS 15800

ONS 15801

ONS 15808

CRS-1

XR 12000


Step 1 In the Domain Explorer, select an NE and choose Administration > Image Transfer. The Image Transfer dialog box opens.

Step 2 Select the source files from the Local File Selection list. Click Browse to locate files that are not visible in the field. You can select multiple files from the local machine for the upload process.

Step 3 To remove a file from the Local File Selection list, select the file from the list and click Delete.

Step 4 Select the NE-specific folder from the CTM server drop-down list to choose where to transfer the image.

Step 5 To remove a file that is already present on the CTM server, select the file from the list and click Delete.

Step 6 Click Upload.



Note If you cancel the image transfer process while it is in progress, only the files that have already been transferred at the time of cancellation are retained. The current file being transferred and other pending files are canceled.


4.3.7  Adding a New NE Software Version to the CTM Domain

The Supported NE table provides information about the software version that is currently supported on a selected NE.

Use this procedure only to apply a minor upgrade to the default, CTM-supported software on the supported NE. Major upgrades to NE software might require you to update CTM.


Caution It is recommended that this feature be used only at the advice of a Cisco technical support engineer. If incorrect modifications to data in the Supported NE table are made, the CTM server might not communicate with one or more NEs in the domain.


Step 1 In the Domain Explorer window, choose Administration > Supported NE Table. Table 4-12 describes the fields in the Supported NE table.

Step 2 Select an NE.


Caution Make sure to select the correct NE row in the Supported NE table before proceeding. If the new software version is added to the wrong NE, the updated NE in the CTM domain will show erroneous behavior.

Step 3 Choose Edit > Add (or click the Add Supported NE tool). The Add Supported NE dialog box opens.

Step 4 The NE model and the NE version fields are initialized with the corresponding values in the selected row. 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 to communicate with it. The server will manage the NE if communication is established.


Note The background of the Supported NE Table is gray by default. The background for newly added NEs changes to white.



Table 4-12 Field Descriptions for the Supported NE Table 

Column Name
Description

NE Model

Displays the model of the selected NE.

Note The Supported NE table includes passive NEs, such as the ONS 15216 DCU and OSC. Passive NEs are shown in the Supported NE table for informational purposes only. The CTM server does not check the software validity of passive NEs.

Software Version

Specifies the software version that is supported on the selected NE.

Note You cannot delete the default NE software version. The default software version rows are created when the CTM server is installed. These rows are the factory-default settings and cannot be deleted.

Note For the ONS 1580x, this field shows the TL1 agent version, not the NE release version. If only the first two digits of the TL1 agent version are specified, all versions in that release will be managed. For example, if TL1 agent version 2.1 is specified, all 2.1.x versions will be managed.

Version Name

Specifies the software version name. For example, "15454 5.00" represents ONS 15454 SONET Release 5.0.


4.3.8  Deleting an NE Software Version from the CTM Domain


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

Step 2 Select the NE for which you want to delete the software version; then, choose Edit > Delete (or click the Delete Supported NE Version tool).


Note NE images that were manually added can be deleted. Default NE images cannot be deleted.


Step 3 Click OK in the confirmation dialog box.


4.4  How Do I Modify the Network?

This section contains the following information:

Changing IP Addresses for NEs

Updating the Configuration Files After Changing the CTM Server IP Address

Changing the Internal Subnet Address—ONS 15600

Viewing and Changing the Network Address—CTC-Based NEs

Configuring Proxy Server Settings—CTC-Based NEs

Changing the Operational State of an NE

Setting Date, Time, and Location on CTC-Based NEs

Configuring SNTP for Multiple NEs

Configuring Application-Specific Parameters


Note For information about setting up routing protocols, see 5.3  Configuring Routing Protocols on Optical NEs, page 5-6.


4.4.1  Changing IP Addresses for NEs

CTM supports an active IP address, a primary IP address, and a secondary IP address:

Active IP address—Displays the active IP address of the selected NE. For all ONS 15000 NEs except the ONS 15800, ONS 15801, and ONS 15808, the active IP address field for end NEs (ENEs) is the IP address of the gateway NE (GNE) that the NE is using.

For the ONS 15800, ONS 15801, and ONS 15808, this field displays either the primary or secondary IP address, depending on which address is used to reach the NE.

Primary IP address—(Applicable only to the ONS 15800, ONS 15801, and ONS 15808) Displays the primary IP address.

Secondary IP address—(Applicable only to the ONS 15800, ONS 15801, and ONS 15808) Displays the backup IP address that the CTM server uses to reach the ONS 1580x NE when connectivity through the primary IP address is disrupted. For ONS 15800, ONS 15801, and ONS 15808 NEs:

The secondary IP address points to a backup address that is remapped to the ONS 15800, ONS 15801, or ONS 15808 primary address. This backup address allows CTM to reach the ONS 1580x node through a different route by using Layer 3 routing instead of the less-secure Layer 2 routing. If the CTM server cannot connect to the NE through either the primary or secondary IP address, the NE is marked as unreachable. To disable the secondary IP address for the ONS 1580x, enter the same address for both the primary and secondary IP addresses.

If the primary IP address is changed when the communication state is available and the operational state is In Service or Under Maintenance, the actual node IP address changes. CTM resets the NE automatically to activate the new IP address. After resetting the active IP address, the primary IP address and secondary IP address have the same value. Reset the network address translation (NAT) address on the router to map the NAT address to the new Control and Monitoring Processor (CMP) module address before resetting the secondary IP address.

If the primary IP address is changed when the communication state of the ONS 1580x NE is unavailable (communication state is independent of the operational state), the primary, secondary, and active IP addresses are changed only in CTM. No IP address change requests are sent to the NE.

If the active IP address is changed from a primary to a secondary IP address, an alarm is generated. The alarm is cleared when the IP address is switched back to the primary IP address.

4.4.1.1  Changing the NE IP Address on CTC-Based NEs


Step 1 In the Domain Explorer window, click the NE and choose Configuration > NE Explorer.

Step 2 In the property sheet of the NE Explorer, select the Network tab.

Step 3 Select the Address subtab.

Step 4 Change the IP address in the IP Address field. Make sure that the new IP address is not in use.


Note If you enter an IP address that is already in use, you receive the error message "A network element with this IP address already exists in the database, or this is a secure IP address." You must enter a unique IP address.


Step 5 If necessary, change the following fields:

Default Router

Subnet Mask

Step 6 Click Apply.

Step 7 A confirmation dialog box informs you that the NE will reboot. Click Yes. CTM will lose connectivity to the NE. After several minutes, the NE will be back in service with the new IP address.


4.4.1.2  Changing the NE IP Address in a GNE/ENE Environment

When changing NE IP addresses in a GNE/ENE environment, change the IP address on the end NE (ENE) node first; then, change the IP address on the GNE node. You do not need to remove NEs from CTM.


Note This procedure applies only to NE releases 5.0 and later.


To change the IP address of a GNE and then convert all GNE/ENE settings to LAN-connected NE (LNE) in CTM:


Step 1 Remove the ENE settings on the ENE. In the Network Explorer, click the Network tab > Firewall/Proxy subtab; then, uncheck the Enable Proxy Server on Port check box.

Step 2 Launch the NE Explorer for the ENE and click the Network tab > Address subtab. Change the IP address of the ENE. The NE reboots and does not come back up until the cable connections are correct in the network.

Step 3 Make the necessary cable connections to all NEs in the topology. (In this case, make all the NEs LAN-cable connected.)

Step 4 Remove the GNE settings on the GNE. In the Network Explorer, click the Network tab > Firewall/Proxy subtab; then, uncheck the Enable Proxy Server on Port check box.

The GNE becomes unavailable in CTM. After some time, the GNE comes up as an LNE in CTM.

Step 5 Wait until all the NEs come up as LNEs in CTM.


4.4.1.3  Changing the IP Address in CTM Only

You can change only the IP address of a GNE. The IP address of an ENE cannot be changed.


Step 1 In the Domain Explorer tree, select the NE that will be changed.

Step 2 Click the Address tab. In the Active IP Address field, enter the new IP address. For the ONS 15800, ONS 15801, and ONS 15808, in the Primary IP Address or Secondary IP Address field, enter the IP address. The IP address must be unique and in the form ddd.ddd.ddd.ddd, where ddd is a decimal octet expressed as an integer from 0 to 255. The first octet cannot be a zero.

Step 3 Click Save.



Caution For the ONS 15800, ONS 15801, and ONS 15808, be careful while entering the primary IP address. If the primary IP address for an in-service or under-maintenance ONS 15800, ONS 15801, or ONS 15808 is mistyped and saved, the NE becomes unreachable. This occurs because CTM resets the NE to make the new IP address effective. Use the TL1 interface to correct the mistake.


Note If the IP address is changed in CTM, the change is made only in CTM. Use the CLI if changes in the IP address need to be applied to the ONS 155xx NEs. Choose Configuration > ONS 155XX > Launch CLI in the Domain Explorer.



Note When the new primary IP address is set for the ONS 15800, ONS 15801, or ONS 15808, the secondary IP address is changed to the same address. Set a new address in the Secondary IP Address field.

Changing the active IP address of ONS 15800, ONS 15801, or ONS 15808 equipment is only possible if the ONS 15800, ONS 15801, or ONS 15808 NE has never been reached by CTM. Otherwise, the CTM user can set a different primary or secondary IP address.


4.4.1.4  Changing the IP Address when CTM and Oracle Are on the Same Server

To change the IP address of a standalone CTM server with a single IP interface when CTM and Oracle are on the same server, proceed as follows.


Step 1 Log into the CTM server as the root user.

Step 2 Enter the following command to shut down the CTM server:

ctms-stop

Step 3 Enter the following commands to shut down Oracle:

# su - oracle
% sqlplus /nolog
SQL> connect <username>/<password> as sysdba
SQL> shutdown immediate;
SQL> exit
% exit

Step 4 Complete the following:

a. Enter the following command to change the IP address in the /etc/netmasks file:

#vi /etc/netmasks

b. Enter the following command to change the IP address in the /etc/hosts file:

# vi /etc/hosts

c. Enter the following command to change the IP address in the etc/hostname.xxx file, where xxx is the IP interface that is defined in the Solaris server:

# vi /etc/hostname.xxx

d. Enter the following command to change the default router file, if required:

# vi /etc/defaultrouter

e. Enter the following command to change the subnet mask on the CTM server:

# vi /etc/netmasks

Step 5 Complete the following application-level steps:

a. Enter the following command to change the IP address in the Oracle listener file:

# vi /oraclesw9i/product/9.2/network/admin/listener.ora

b. Enter the following command to change the IP address in the Oracle tnsnames file:

# vi /oraclesw9i/product/9.2/network/admin/tnsnames.ora

c. Enter the following command to change the IP address in the CTM server configuration file:

# vi /opt/CiscoTransportManagerServer/cfg/CTMServer.cfg


Note Make sure to change all IP addresses where they are referenced.


d. Enter the following command to change the IP address in the jacORB properties file:

# vi /opt/CiscoTransportManagerServer/openfusion/classes/jacorb.properties

e. Enter the following command to change the IP address in the web server configuration file:

# vi /opt/CiscoTransportManagerServer/webServer/conf/httpd.conf

Step 6 Enter the following commands to halt and reboot the CTM server:

# sync;sync;halt
OK boot -r

Step 7 After the CTM server has rebooted, enter the following command to verify that the CTM server has started:

# showctm

Step 8 Enter the following command to stop the CTM server:

# ctms-stop

Step 9 Enter the following command to update the Orbix domain:

# /opt/CiscoTransportManagerServer/cwm/svplus/scripts/conf_orbix.csh PUBLISH_IP 
<new_IP_Address>

Step 10 Enter the following command to start the CTM server:

# ctms-start


4.4.1.5  Changing the IP Address on the ONS 15800, ONS 15801, and ONS 15808 NE


Step 1 In the Domain Explorer, select the ONS 15800, ONS 15801, or ONS 15808 NE and choose Configuration > NE Explorer.

Step 2 In the NE Explorer Properties pane, click the Address tab. Specify the following:

Active IP Address—Primary or secondary IP address currently used to reach the NE

Primary IP Address—Primary IP address of the NE

Secondary IP Address—Backup IP address used to reach the NE

Subnetwork Mask—Subnetwork mask for the NE

Default Router—IP address of the default router for the NE


Note When the primary and secondary IP addresses are the same, the secondary IP address is not supported. For the ONS 15808 NEs, the secondary IP address points to a backup IP address that is remapped to the ONS 15808 primary IP address. This backup address allows CTM to reach the ONS 15808 node through a different route by using Layer 3 routing instead of the less-secure Layer 2 routing.

If you change the primary IP address when the ONS 15808 is in service or under maintenance, the actual node IP address changes. CTM resets the NE automatically to activate the new IP address. After resetting the active IP address, the primary IP address and secondary IP address have the same value. If you want to reset the secondary IP address, you should first reset the NAT address on the router to map the NAT address to the new CMP module address.


Step 3 Click Apply.


4.4.1.6  Changing the IP Address on the MGX Switch

In CTM, the IP address field for an NE is read-only and cannot be modified. If a user changes the IP address on the MGX switch, CTM receives traps and updates the IP address on the clients and in the database.

4.4.2  Updating the Configuration Files After Changing the CTM Server IP Address

If you change the CTM server IP address (as shown in Changing the IP Address when CTM and Oracle Are on the Same Server), you must replace the old IP address with the new IP address in the configuration files shown in the following table. Use a standard UNIX text editor such as vi to update the files. Changes in the configuration files take effect after rebooting the server.

Table 4-13 Configuration Files that Require Updating 

Filename
Location
UNIX Configuration Files

hosts

/etc

netmasks

/etc

defaultrouter

/etc

Oracle Configuration Files

tnsnames.ora

/oraclesw9i/product/9.2/network/admin

listener.ora

/oraclesw9i/product/9.2/network/admin

CTM Server Configuration File

CTMServer.cfg

/opt/CiscoTransportManagerServer/cfg

jacorb.properties

/opt/CiscoTransportManagerServer/openfusion/classes

httpd.conf

Note Two IP address instances require modification:

Listen <IP_address>:51
ServerName <IP_address>:51

/opt/CiscoTransportManagerServer/webServer/conf

CTMServer.perm

/opt/CiscoTransportManagerServer/cfg/

NotificationService.xml

/opt/CiscoTransportManagerServer/openfusion/domains/
OpenFusion/localhost/NotificationService/


4.4.3  Changing the Internal Subnet Address—ONS 15600

To avoid IP address conflicts, change the class B subnet address if your internal network uses the same address range as the default subnet address. To change class B subnet address for the TSC cards, complete the following steps.


Caution All network changes should be approved by your network administrator.


Step 1 In the Domain Explorer tree, select an ONS 15600 SONET or ONS 15600 SDH NE.

Step 2 Choose Configuration > NE Explorer (or click the Open NE Explorer tool).

Step 3 In the node properties pane of the NE Explorer, select the Network tab.

Step 4 Select the Internal Subnet subtab.

Step 5 Specify the following in the TSC section:

TSC1—Class B subnet address for the first TSC.

TSC2—If there are two TSCs are installed, enter the class B subnet address for the second TSC.

Step 6 Click Apply.


4.4.4  Viewing and Changing the Network Address—CTC-Based NEs


Step 1 In the Domain Explorer tree, select a CTC-based NE and choose Configuration > NE Explorer (or click the Open NE Explorer tool).

Step 2 In the node properties pane of the NE Explorer, select the Network tab.

Step 3 Select the Address subtab.

Step 4 Complete the following information:

IP Address—IP address of the NE.

Default Router—IP address of the default router.

Subnet Mask—Subnetwork mask ID of the NE.

MAC Address—Read-only. Address as identified in the IEEE 802 MAC layer.

LCD IP Setting—(ONS 15454 SONET and SDH only) Select one of the following:

Allow Configuration—Allows users to change the shelf IP address from the LCD screen.

Display Only—Displays the shelf IP address in the LCD screen and does not allow any configuration.

Suppress Display—Shelf IP address is not displayed in, and cannot be configured from, the LCD screen.

Forward DHCP Requests—When checked, forwards the Dynamic Host Configuration Protocol (DHCP) requests to the IP address.

DHCP Server—IP address of the DHCP server.

Step 5 In the node properties pane of the NE Explorer, click the Security tab > Access subtab. Complete the following information:

CORBA (IIOP) Listener Port—Allows you to set a listener port to allow communication with the NE through firewalls. Select one of the following:

Default-Fixed

Standard Constant (683)

Other Constant

Step 6 Click Apply.


4.4.5  Configuring Proxy Server Settings—CTC-Based NEs

CTC-based NEs have a proxy server feature set that allows networking these NEs in environments where visibility and accessibility are restricted. In the proxy server environment, CTC-based NEs are designated as either gateway NEs (GNEs) or end NEs (ENEs). The GNE is LAN-connected to the DCN, while the ENE is accessed through the proxy server feature on the GNE over the section DCC (SDCC). The ENE is not directly accessible through the IP address, while the GNE has an IP address that is valid for the DCN LAN. CTM can manage CTC-based NEs deployed in a proxy environment.


Step 1 In the Domain Explorer tree, select a CTC-based NE.

Step 2 Choose Configuration > NE Explorer (or click the Open NE Explorer tool).

Step 3 In the Properties pane of the NE Explorer, select the Network tab.

Step 4 Select the Firewall/Proxy subtab.

Step 5 Check the Enable proxy server on port check box. When enabled, the NE serves as a proxy for connections between CTC clients and the NEs that are DCC-connected to proxy NEs. Uncheck the check box to disable the proxy. The on port field has a Cisco default value of 1080.

Step 6 You can enable the proxy on one of the following:

ENE

GNE

Proxy-only

If ENE and GNE are in different IP subnets, or if ENE and GNE are in different Ethernet segments, proxy should be enabled on the GNE. If firewall is enabled on the GNE, it prevents communication between the laptop connected to the LAN port of the ENE and network operations center (NOC), even if proxy is enabled on both the ENE and GNE. Whenever firewall is enabled on a GNE, proxy should be enabled on the GNE as well.

Step 7 Click Apply.


4.4.5.1  Notes on Configuring Proxy Server Settings

Note the following when configuring proxy server settings:

In a proxy environment, you can launch CTC from CTM for a proxy GNE if you are launching CTC for an ENE. CTC cannot be launched for a non-GNE if the proxy GNE is marked Out of Service or is not reachable from CTM. Launching CTC for NEs that are not reachable before CTM can determine whether they are reachable or not displays the error messages "Error in launching CTC node view for <NE>" and "Initializing Class Loaders Failed-Timeout opening <NE IP>:<Port>."

In a proxy environment, you cannot launch a TL1 Telnet session directly for an NE. You can launch the Telnet window for the GNE and then enter the ACT-USER command, specifying the ENE as the TID.

CTM can configure multiple GNEs but it can only associate a single GNE for a given ENE. If the GNE becomes inaccessible, CTM can automatically use one of the other available GNEs to reach the ENE.

When a proxy-enabled GNE (named GNE1) is first added to CTM, CTM automatically discovers all associated NEs (through the topology discovery feature) and identifies them as ENEs associated with GNE1. If there are other proxy-enabled GNEs that are discovered from GNE1, CTM will still mark them as ENEs associated with GNE1. When proxy is enabled on any GNE, all ENEs lose connectivity and eventually regain it. In a multiple DCC-connected GNE scenario, NEs that do not regain connectivity should be marked Out of Service, then marked In Service again.

If both LAN and data communications channel (DCC) connections exist between the GNE and ENEs, the DCC connection takes precedence.

In order to collect PM data on ENEs, PM collection on the GNE must be set to either 15 Min or 1 Day.

4.4.5.2  Configuring Proxy Server Settings for NEs Equipped with ML-Series Cards

CTM supports only the following configurations for NEs that are equipped with ML-series cards:

GNE with SNMP v1 and v2


Note CTM considers an NE to be a GNE if proxy-only is enabled, or if proxy with firewall is enabled.


ENE with SNMP v1 and v2


Note CTM considers an NE to be an ENE if proxy is not enabled, or if proxy/firewall and craft access are enabled.


For NE release 4.6 and earlier, see Table 4-14. For NE release 5.0, see Table 4-15. In order for CTM to support a proxy/firewall scenario, the scenario must have a "Yes" in all four columns of the table, and CLI launch must be supported.

For an explanation of proxy server settings on the NEs, refer to the NE hardware documentation.

The following table describes the proxy server settings for release 4.6 and earlier NEs.

Table 4-14 Proxy Server Settings for Release 4.6 and Earlier NEs 

Proxy Scenario
FM
CM
PM
RMON Threshold
Proxy only, GNE (CLI launch is supported)1

SNMP v1

No

Yes

Yes

Yes

SNMP v2

Yes

Yes

Yes

Yes

Proxy only, ENE (CLI launch is not supported)2

SNMP v1

No

Yes

Yes

No

SNMP v2

No

Yes

Yes

No

Proxy and internal firewall, GNE (CLI launch is supported)3

SNMP v1

No

Yes

Yes

Yes

SNMP v2

Yes

Yes

Yes

Yes

Proxy and internal firewall, ENE (CLI launch is not supported)4

SNMP v1

No

Yes

Yes

No

SNMP v2

No

Yes

Yes

No

Proxy only, GNE, with external firewall and NAT (CLI launch is not supported)5

SNMP v1

No

Yes

Yes

No

SNMP v2

Yes

Yes

Yes

No

Proxy only, GNE, with internal firewall, external firewall, and NAT (CLI launch is not supported)6

SNMP v1

No

Yes

Yes

No

SNMP v2

No

Yes

Yes

No

Proxy only, ENE, with internal firewall, external firewall, and NAT (CLI launch is not supported)7

SNMP v1

No

Yes

Yes

No

SNMP v2

No

Yes

Yes

No

External firewall and PAT8 (CLI launch is not supported)9

SNMP v1

No

No

No

No

SNMP v2

No

No

No

No

1 In this scenario, the NE is set up as a GNE with proxy enabled. The internal firewall is not turned on and there is no external firewall between the server and the NEs.

2 In this scenario, the NE is set up as an ENE with proxy enabled. The internal firewall is not turned on and there is no external firewall between the server and the NEs.

3 In this scenario, the NE is set up as a GNE with proxy and internal firewall enabled. There is no external firewall between the server and the NEs.

4 In this scenario, the NE is set up as an ENE with proxy and internal firewall enabled. There is no external firewall between the server and the NEs.

5 In this scenario, the NE is set up as a GNE with proxy enabled. The internal firewall is not turned on. There is an external firewall between the server and the NEs that is using NAT.

6 In this scenario, the NE is set up as a GNE with proxy and internal firewall enabled. There is an external firewall between the server and the NEs that is using NAT.

7 In this scenario, the NE is set up as an ENE with proxy and internal firewall enabled. There is an external firewall between the server and the NEs that is using NAT.

8 PAT = Port Address Translation

9 There is an external firewall between the server and the NEs that is using PAT. The NE and CTM do not support this configuration.


The following table describes the proxy server settings for release 5.0 and later NEs.

Table 4-15 Proxy Server Settings for Release 5.0 and Later NEs 

Proxy Scenario
FM
CM
PM
RMON Threshold
Proxy only, GNE (CLI launch is supported)1

SNMP v1

Yes

Yes

Yes

Yes

SNMP v2

Yes

Yes

Yes

Yes

Proxy only, ENE (CLI launch is not supported)2

SNMP v1

Yes

Yes

Yes

Yes

SNMP v2

No

Yes

Yes

Yes

Proxy and internal firewall, GNE (CLI launch is supported)3

SNMP v1

Yes

Yes

Yes

Yes

SNMP v2

Yes

Yes

Yes

Yes

Proxy and internal firewall, ENE (CLI launch is not supported)4

SNMP v1

Yes

Yes

Yes

Yes

SNMP v2

No

Yes

Yes

Yes

Proxy only, GNE, with external firewall and NAT (CLI launch is not supported)5

SNMP v1

Yes

Yes

Yes

Yes

SNMP v2

Yes

Yes

Yes

Yes

Proxy only, GNE, with internal firewall, external firewall, and NAT (CLI launch is not supported)6

SNMP v1

Yes

Yes

Yes

Yes

SNMP v2

Yes

Yes

Yes

Yes

Proxy only, ENE, with internal firewall, external firewall, and NAT (CLI launch is not supported)7

SNMP v1

Yes

Yes

Yes

Yes

SNMP v2

No

Yes

Yes

Yes

External firewall and PAT (CLI launch is not supported)8

SNMP v1

No

No

No

No

SNMP v2

No

No

No

No

1 In this scenario, the NE is set up as a GNE with proxy enabled. The internal firewall is not turned on and there is no external firewall between the server and the NEs.

2 In this scenario, the NE is set up as an ENE with proxy enabled. The internal firewall is not turned on and there is no external firewall between the server and the NEs.

3 In this scenario, the NE is set up as a GNE with proxy and internal firewall enabled. There is no external firewall between the server and the NEs.

4 In this scenario, the NE is set up as an ENE with proxy and internal firewall enabled. There is no external firewall between the server and the NEs.

5 In this scenario, the NE is set up as a GNE with proxy enabled. The internal firewall is not turned on. There is an external firewall between the server and the NEs that is using NAT.

6 In this scenario, the NE is set up as a GNE with proxy and internal firewall enabled. There is an external firewall between the server and the NEs that is using NAT.

7 In this scenario, the NE is set up as an ENE with proxy and internal firewall enabled. There is an external firewall between the server and the NEs that is using NAT.

8 There is an external firewall between the server and the NEs that is using PAT. The NE and CTM do not support this configuration.


4.4.5.3  Conditions Under Which CTM Recognizes an NE as an LNE, a GNE, or an ENE

An NE in CTM can show up as a GNE, an ENE or an LNE. This type is denoted in a small rectangle next to the corresponding NE in the Domain Explorer tree view. The following tables document how CTM determines whether an NE in the network is considered a GNE, ENE or LNE.

LAN Connected denotes whether the NE is connected directly to the LAN.

Proxy Enabled denotes whether the Enable Proxy option is checked for the NE (in NE Explorer, in the Network -> Firewall/Proxy tab)

Firewall Enabled denotes whether the Enable Firewall option is checked for the NE (in NE Explorer, in the Network -> Firewall/Proxy tab)

Craft Access Enabled denotes whether the Craft-Access Only option is checked for the NE (in NE Explorer, in the Network -> Firewall/Proxy tab)

GNE denotes whether the Gateway Network Element (GNE) option is selected for the NE (in NE Explorer, in the Network -> Firewall/Proxy tab)

ENE denotes whether the End Network Element (ENE) option is selected for the NE (in NE Explorer, in the Network -> Firewall/Proxy tab)

Proxy-only denotes whether the Proxy-only option is selected for the NE (in NE Explorer, in the Network -> Firewall/Proxy tab)

A value of N/A indicates that the setting for that column is irrelevant to the end result


Note For all cases where the NE type is denoted as ENE, per current CTM design, an ENE will not have connectivity in CTM unless there is at least one GNE in the same ring as the ENE.


Table 4-16 NE Releases 4.1.x (15454 SONET/SDH, 15327) 

NE Settings
NE Type
LAN Connected?
Proxy Enabled?
Firewall Enabled?
Craft Access Enabled? 1

Yes

Yes

Yes

No

GNE

Yes

Yes

No

No

GNE

No

Yes

Yes

No

GNE

No

Yes

No

No

GNE

N/A

No

No

Yes

ENE

N/A

Yes

Yes

Yes

ENE

No

Yes

No

Yes

ENE

No

No

No

Yes

ENE

No

No

No

No

ENE2

Yes

No

No

No

ENE3

Yes

No

No

No

LNE4

1 15454 SONET/SDH, 15310 and 15327 NEs have a single ethernet port, and enabling the Craft-Access Only option for these NEs disables this port. 15600 NEs however have two separate and independent ethernet ports, therefore this option is not applicable in their case.

2 CTM will discover this NE as an ENE if there is at least one GNE on the same DCC domain with proxy server enabled. Note that this is not a supported configuration. It has been documented for reference purposes only.

3 CTM will discover this NE as an ENE if there is at least one GNE on the same DCC domain with proxy server enabled. Note that this is not a supported configuration. It has been documented for reference purposes only.

4 CTM will discover this NE as an LNE if all the NEs on the same DCC domain have proxy server disabled.


Table 4-17 15600 SONET NE Settings (1.1.2, 1.1.3,1.3.1) 

NE Settings
NE Type
LAN Connected?
Proxy Enabled?
Firewall Enabled?

Yes

Yes

Yes

GNE

Yes

Yes

No

GNE

No

Yes

Yes

GNE1

No

Yes

No

GNE2

No

Yes

No

GNE3

No

No

No

ENE4

Yes

No

No

ENE5

Yes

No

No

LNE6

1 CTM will discover only the first such NE as a GNE. All other NEs with identical settings that are in the same DCC domain will be discovered as ENEs.

2 CTM will discover only the first such NE as a GNE. All other NEs with identical settings that are in the same DCC domain will be discovered as ENEs.

3 CTM will discover only the first such NE as a GNE. All other NEs with identical settings that are in the same DCC domain will be discovered as ENEs.

4 CTM will discover this NE as an ENE if there is at least one GNE on the same DCC domain with proxy server enabled. Note that this is not a supported configuration - it has been documented for reference purposes only.

5 CTM will discover this NE as an ENE if there is at least one GNE on the same DCC domain with proxy server enabled. Note that this is not a supported configuration - it has been documented for reference purposes only.

6 CTM will discover this NE as an LNE if all the NEs on the same DCC domain have proxy server disabled.


Table 4-18 ONS15600 SDH NE Release 1.4 

NE Settings
NE Type
LAN Connected?
Proxy Enabled?
Firewall Enabled?

Yes

Yes

Yes

GNE

Yes

Yes

No

GNE

No

Yes

Yes

GNE

No

Yes

No

GNE

No

Yes

No

GNE

No

Yes

No

GNE

No

No

No

ENE

Yes

No

No

LNE


Table 4-19 NE Release 4.6 and Newer (ONS15454 SONET/SDH/327/310) 

NE Settings
NE Type
GNE1
ENE2
Proxy-only3

Yes

N/A

N/A

GNE

N/A

Yes

N/A

GNE

N/A

N/A

Yes

GNE

No

No

No

ENE4

No

No

No

LNE5

1 The GNE, ENE, and Proxy-only options are available after checking the Enable Proxy Server option in NE Explorer.

2 The GNE, ENE, and Proxy-only options are available after checking the Enable Proxy Server option in NE Explorer.

3 The GNE, ENE, and Proxy-only options are available after checking the Enable Proxy Server option in NE Explorer.

4 CTM will discover this NE as an ENE if there is at least one GNE on the same DCC domain with proxy server enabled. Note that this is not a supported configuration - it has been documented for reference purposes only.

5 CTM will discover this NE as an LNE if all the NEs on the same DCC domain have proxy server disabled.


Table 4-20 NE Release 5.0 and Newer (ONS15600)

NE Settings
NE Type
GNE1
ENE2
Proxy-only3

Yes

N/A

N/A

GNE

N/A

Yes

N/A

GNE4

N/A

N/A

Yes

GNE

No

No

No

ENE5

No

No

No

LNE6

1 The GNE, ENE, and Proxy-only options are available after checking the Enable Proxy Server option in NE Explorer.

2 The GNE, ENE, and Proxy-only options are available after checking the Enable Proxy Server option in NE Explorer.

3 The GNE, ENE, and Proxy-only options are available after checking the Enable Proxy Server option in NE Explorer.

4 CTM uses the Craft-Access Only setting on the NE to distinguish between a GNE and an ENE. For 15600s this is always false so CTM will detect an NE as a GNE even if the ENE option is set on the NE. Also, the CTM NE Explorer GUI in 5.0.2 will still show the old style GUI for proxy settings (as shown in pre 5.0 versions of 15600).

5 CTM will discover this NE as an ENE if there is at least one GNE on the same DCC domain with proxy server enabled. Note that this is not a supported configuration - it has been documented for reference purposes only.

6 CTM will discover this NE as an LNE if all the NEs on the same DCC domain have proxy server disabled.


4.4.6  Changing the Operational State of an NE


Step 1 In the Domain Explorer tree, select the NE that will be changed.

Step 2 In the Network Element Properties pane > Operational State field, choose one of the following operational states:

Preprovisioned (not available if already provisioned)—The NE has been added to the database for provisioning but is not yet in service. CTM does not manage preprovisioned NEs.

In Service—The NE is deployed and requires monitoring. CTM collects polling, fault management (FM), configuration management (CM), and PM data from in-service NEs and stores the data in the database.

Out of Service—The NE has been marked Out of Service by a network administrator and does not require monitoring. The CTM database records the last known state of the NE when it was in service.

Under Maintenance—The NE is temporarily under maintenance but requires monitoring. This state is the same as In Service except that CTM does not report alarms or events for under-maintenance NEs.


Tip You can also right-click an NE in the Domain Explorer tree or Subnetwork Explorer tree and choose Mark Under Maintenance, Mark In Service, or Mark Out of Service from the shortcut menu.


There are two additional states that you cannot choose. These operational states are changed by CTM based on the initialization tasks that are completed:

In Service-Initializing—The NE is marked as In Service-Initializing when CTM reaches connectivity of the NE (Communication State is marked as Available) and the discovery process starts. The initialization process is completed when fault and inventory have been synchronized. The operational state changes from In Service-Initializing to In-Service Synch Configuration.

In-Service Synch Configuration—The NE is marked as In-Service Synch Configuration when CTM uploads a configuration for that NE. You can change the operational state of an NE from In-Service Synch Configuration to Out of Service.

Step 3 Click Save.

Step 4 Click Yes in the confirmation dialog box.



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



Note When you mark an NE as Out of Service and then mark it as In Service, the CTM alarm time stamp in the Alarm Browser window is resynchronized with the time stamp when the NE is put back in service.


4.4.7  Setting Date, Time, and Location on CTC-Based NEs


Step 1 In the Domain Explorer, select an NE and choose Configuration > NE Explorer.

Step 2 In the node properties pane, click the Identification tab.

Step 3 In the Location area:

Set the latitude of the NE by selecting North or South from the Latitude drop-down list; then, enter the degrees and minutes (or click the up or down arrow to increase or decrease each by 1 unit).

Set the longitude of the NE by selecting East or West from the Longitude drop-down list; then, enter the degrees and minutes (or click the up or down arrow to increase or decrease each by 1 unit).

Step 4 In the Date and Time area:

Time—Enter the date and time.

Time Zone—From the drop-down list, select the time zone where the NE is located.

Use Daylight Savings Time—When checked, Daylight Savings Time is observed.

Step 5 Click Apply.


4.4.7.1  Using the SNTP Server to Set the Date and Time

Simple Network Time Protocol (SNTP) is an internet protocol used to synchronize the clocks of computers to a time reference. Using the SNTP server ensures that all NEs use the same date and time reference. The server synchronizes the node's time after power outages or software upgrades. To use the SNTP server to set the date and time for CTC-based NEs, complete the following steps.


Step 1 In the Domain Explorer, select an NE and choose Configuration > NE Explorer.

Step 2 In the node properties pane, click the Identification tab.

Step 3 In the SNTP Settings area, do one of the following:

Set up the SNTP server to set the date and time of the node:

Check the Use NTP/SNTP Server check box.

Enter the SNTP server's IP address.

If you do not use the SNTP server, in the Date and Time area, enter the date and time in the Time field (for more information, see Setting Date, Time, and Location on CTC-Based NEs).

Step 4 Click Apply.


4.4.8  Configuring SNTP for Multiple NEs

Use the SNTP Configuration dialog box to provision a set of SNTP parameters on multiple NEs at the same time.

When the SNTP address setting on an NE fails, the reason for the failure is logged in the Error Log table. As part of a bulk SNTP operation, if the setting on an NE fails, CTM continues to set the SNTP server address on the remaining NEs that are part of the operation.


Note SNTP configuration is not available for ONS 15216, CRS-1, XR 12000, or Catalyst 6509 NEs.



Step 1 In the Domain Explorer, choose Administration > SNTP Configuration. The SNTP Configuration dialog box opens. Table 4-21 provides descriptions.

Step 2 Enter the following information:

NEs

Job comments

SNTP

Time (time zone)

Step 3 Click Finish.

A job is scheduled for each NE that was assigned the SNTP server IP address. The job status is listed in the Job Monitor table. (For more details, see Viewing the Job Monitor Table.) The status of each SNTP set operation is updated as the job progresses. Job status can be one of the following:

Queued—The job has been scheduled but has not yet been processed.

Running—The job is being processed.

Succeeded—The SNTP server IP address is set on the NE.

Failed—The SNTP server IP address was not set on the NE. The reason for the failure is logged in the Error Log table.

Waiting—The job is waiting for the NE to be in service.


Table 4-21 Field Descriptions for the SNTP Configuration Dialog Box 

Field
Description

Network Elements

Use the Add and Remove buttons to move NEs to the Selected NEs list, or to remove NEs from the list. The SNTP server address is set on the NE(s) in the Selected NEs list.

Job Comments

Enter comments about the SNTP server address setting, if needed.

SNTP

Use the Resync Time (1530x only) field if you want the ONS 1530x NE to use the SNTP server to synchronize time information. The Resync Time field is the time passed between two synchronization operations. The NE uses this information to know when to synchronize with the SNTP server.

If you check the Use NTP/SNTP Server check box, CTM uses the NTP or SNTP server to set the date and time of the node. Using the NTP or SNTP server ensures that all NEs use the same date and time reference. After checking the check box, enter the server IP address in the SNTP IP Address field. If you do not check the Use NTP/SNTP Server check box, the NE stores the NTP or SNTP address but does not use it to synchronize time information.

Time (time zone)

Set a time for the SNTP address setting. Click Now to begin immediately, or click At Time and specify when to begin the SNTP set, specifying the month, day, year, hour, and minute in 5-minute increments.

Note The time zone can be GMT, a user-defined offset from GMT, or local time, depending on what is specified in the User Preferences dialog box.


4.4.9  Configuring Application-Specific Parameters

The UI Properties pane allows you to configure application-specific parameters.


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

Step 2 In the Control Panel window, click UI Properties to open the UI Properties pane. The following table describes the fields in the UI Properties pane.

Step 3 After making your selections, click Save.


Table 4-22 Field Descriptions for the UI Properties Pane 

Field
Description

Fault Management

Alarm Acknowledgement—Allows you to specify automatic or manual alarm acknowledgement in the Alarm Browser window. If you choose manual alarm acknowledgment, you must manually acknowledge alarms. Cleared alarms move from the Alarm Browser to the Alarm Log. If you choose automatic alarm acknowledgment, the CTM server automatically acknowledges alarms when they are cleared and moves them from the Alarm Browser to the Alarm Log. Before alarms move to the Alarm Log, they must be both cleared and acknowledged.

Note You can still manually acknowledge alarms in automatic acknowledgement mode.

Overwrite Alarm Notes—Enables or disables the ability to overwrite alarm notes created by another user.

Alarm Unacknowledgement—Enables or disables the ability to unacknowledge alarms that have been acknowledged.

Circuit Management

Overwrite Circuit Notes: Enables or disables the ability to overwrite circuit notes created by another user.

Domain Management

Allows you to specify how node names longer than 25 characters are truncated in the Network Map. If a string is longer than 25 characters, the first 22 characters display followed by an ellipsis (...). You can choose to truncate the first or last characters of the node name.

CTC Management Domain

Allows you to manage the number of CTC instances for optimal CTC performance. The Cisco default is 10 CTC-based NEs.

Although CTM can support up to 2,500 CTC-based NEs, CTC cannot effectively manage more than a small subset of these NEs. Consequently, the CTM domain must be partitioned into smaller CTC domains with one instance of CTC launched per CTC domain. The specified number of CTC-based NEs determines the number of GNEs, or topology hosts, that constitute each CTC management domain. CTC uses the GNEs provided to discover and display other nodes that are physically connected to the GNEs. For example, if each CTC-based NE ring contains three NEs (including the GNE), CTC discovers and manages 3 x 10 = 30 nodes when the value is set to 10. In environments where most CTC-based NE rings or subnetworks contain 10 to 16 NEs, set this number to a smaller value, such as 3.

Subnetwork Grouping

Enables or disables the ability to automatically group NEs in subnetworks. If you check the Automatically Group NEs in Subnetworks check box, you cannot change the subnetwork of an NE, meaning:

The option of selecting a subnetwork in the Add New NE wizard is disabled and shows <System Default>.

The add NE process applies all automatic grouping rules.

Drag-and-drop functionality is disabled on the Subnetwork Explorer.

You cannot change the subnetwork assignment from the NE Properties pane.

Note During the transient period when this option is changed, any current operations (such as dropping an NE in a subnetwork) are completed.

Port State

If you check the Enable Port State Coloring check box, the NE Explorer shelf views and card-level views report the port and alarm status as a background color.

Note This feature is available only if the card is physically present on the NE and is provisioned in CTM.

Audit Trail State

Allows you to enable or disable audit trail. NEs that are added or discovered will be assigned this setting.


4.5  How Do I Manage Redundancy and Failover?

This section contains the following information:

Backing Up Memory

Restoring Memory

Viewing and Modifying ONS NE Service Properties

Viewing and Modifying CTC Based Network Service Properties

Viewing and Modifying Service Instance Properties

Backing Up Client Files

Restoring Server Configuration Files

Initializing the Node Resync Process

Configuring Nodes for Database Restore—ONS 15600

Comparing Configuration Files—CRS-1 and XR 12000

Managing Protection Groups

Restoring NE Defaults

Configuring Card Redundancy

4.5.1  Backing Up Memory

CTM allows you to backup and restore memory for selected NEs. For example, if you want to save your settings for a particular NE, you can back up the memory for just that NE.

CTM backs up configuration and provisioning information residing in the flash memory of an NE. CTM provides three methods by which to perform the configuration backup operation:

Manually on demand

Scheduling (one time only)

Periodic, automatic scheduling based on a configurable time set by the operator

You can specify the number of backup configurations that should be kept at any given time. The default number is seven.


Note The maximum number of copies that can be saved is dictated by the amount of disk space available.


The oldest configuration that was backed up is replaced by the current backup depending on the (configured) number of copies you want to retain at any given time. The memory restore function in CTM can then be used to roll back to any one of the previous configurations that was saved. Once the configuration is downloaded, you will need to issue CLI commands to activate the new configuration.


Note The restore operation is service affecting, because the node is rebooted to reflect the restored configuration.


Follow the procedures described in these sections to back up and restore memory (configuration data) on NEs. CTM allows you to back up memory for the following NEs:

ONS 15216 EDFA2 (R2.3.0 and later)

ONS 15216 EDFA3

ONS 15310 CL

ONS 15310 MA

ONS 15327

ONS 15454 SONET

ONS 15454 SDH

ONS 15530

ONS 15540 ESP and ESPx

ONS 15600 SONET

ONS 15600 SDH

CRS-1

XR 12000

Cisco MGX Voice Gateway


Note The latest ONS 15216 EDFA2 R2.4 hardware does not support memory backup to a software release other than 2.4.0. The ONS 15216 EDFA2 R2.3 hardware supports memory backup for NE software releases 2.3 and 2.4.



Note For the ONS 15530 and ONS 15540, the SNMP Community String table must have a valid write community string for the NE before memory can be backed up or restored. For more information, see Chapter 3, "Building the Network."



Note CTM R7.0 does not support memory backup for the ONS 15302, ONS 15305, ONS 15501, ONS 15800, ONS 15801, ONS 15808, Catalyst 6509, MDS 9000, or Not Managed/Other Vendor NEs.


The Memory Backup procedure backs up configuration and provisioning information residing in the Flash memory of an NE. By default, the CTM server automatically backs up memory for NEs once a day for seven days and stores the backup files on the CTM server. After seven days, the oldest backup file is replaced by the current backup. For more information, see Configuring Automatic NE Backup Parameters.


Step 1 In the Domain Explorer tree, select a management domain or group that contains an NE that is assigned an In Service or Under Maintenance operational state. Alternatively, select an NE that is assigned an In Service or Under Maintenance state.


Note Memory backup is not allowed for preprovisioned or out-of-service NEs.


Step 2 Choose Administration > Memory Backup.

Step 3 The Memory Backup dialog box opens. Enter the following information (see Table 4-23 for details):

NE model

Selected NEs

Job comments

Tag name

Time (time zone)


Note For the ONS 15216 EDFA2, the backup file must be saved in the default directory, such as the tftpboot directory on the remote TFTP server, in case the file will be restored from the remote TFTP server. The tftpboot directory must have read-write access, or the backup job will fail. See Chapter 3, "Building the Network" for information about how to configure the tftp directory with read-write access.



Note The time zone can be GMT, a user-defined offset from GMT, or local time, depending on what is specified in the User Preferences dialog box.


Step 4 Depending on the type of NE, do one of the following:

For ONS 15530 and ONS 15540 NEs, proceed to Step 5.

For ONS 15600 NEs, proceed to Step 6.

For CRS-1, XR 12000, ONS 15216, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SONET, ONS 15454 SDH NEs, or Cisco MGX NEs, click Finish to initiate the memory backup procedure.

For the CRS-1 and XR 12000, the backed up config files are archived in a directory under $CTM_HOME/admin/<NE_system_ID>. The following naming convention is used for versioning/tagging config files:

<NE_TYPE>-<USER_TAG>-<DATE_AND_TIME>-<JOB_TYPE>.cfg

where:

NE_TYPE is the type of managed NE.

USER_TAG is the user-specified tag name. You can specify any string here.

DATE_AND_TIME is the year, month, day, and time, in YYYYMMDDHHMMSS format. For example, 20030610151159 means that the file was archived on June 10, 2003 at 3:11:59 PM.

JOB_TYPE is auto for automatic jobs, backup/restore for manually created jobs, and CONFIG-CHANGE when the configuration file is backed up after receiving a CONFIG_CHANGE notification.

For the ONS 15216, the configuration file is copied to the $CTMHOME/admin/<NE_system_ID>/15216-<tag_name>-<time_stamp>-backup.cfg file.

For the ONS 15310 CL or ONS 15310 MA, the configuration file is copied to the $CTMHOME/admin/<NE_system_ID>/15310-<tag_name>-<time_stamp>-backup.cfg file.

For the ONS 15327, the configuration file is copied to the $CTMHOME/admin/<NE_system_ID>/15327-<tag_name>-<time_stamp>-backup.cfg file.

For the ONS 15454 SONET or ONS 15454 SDH, the configuration file is copied to the $CTMHOME/admin/<NE_system_ID>/15454-<tag_name>-<time_stamp>-backup.cfg file.


Note If System Default is chosen for the tag name, the tag is left blank and the filename is, for example, 15454--backup.cfg. If User Specified is chosen and hello is entered for the tag name, the filename is 15454-hello-<YYYYMMDDHHMM>-backup.cfg, where YYYYMMDDHHMM is the backup date, consisting of:

YYYY—Four-digit year
MM—Two-digit month
DD—Two-digit day
HH—Two-digit hour (in 24-hour format)
MM—Two-digit minute


For the Cisco MGX NEs, the configuration file is copied to the /opt/CiscoTransportManagerServer/admin/nodename/MGX-timestamp.bkp.cfg file.


Note If User Specified is chosen and hello is entered for the tag name, the filename is MGX-hello-YYYYMMDDHHMM-backup.cfg where YYYYMMDDHHMM is the backup date, consisting of:

YYYY—Four-digit year
MM—Two-digit month
DD—Two-digit day
HH—Two-digit hour (in 24-hour format)
MM—Two-digit minute

A filename, including a user-specified name, cannot exceed 40 characters. If you specify a long filename, it will be truncated to 15 characters.


Step 5 For ONS 15530 and ONS 15540 NEs:

a. Click Next to display memory backup options. Select an option (see Table 4-23 for details):

Running Configuration

Startup Configuration

Save Running Config as Startup Config on NE

b. Click Finish to initiate the memory backup procedure.

The configuration file for each NE is copied to the $CTMHOME/admin/<NE_system_ID>/ 155xx-<tag>-<time_stamp>-<slot_number_of_active_CPU>-[ running | startup].cfg file, where:

$CTMHOME is the installation directory (by default, the installation directory is /opt/CiscoTransportManagerServer).

NE_system_ID is the hostname of the ONS 15501, ONS 15530, or ONS 15540.

tag-time_stamp is the user-defined tag name and includes the time stamp. If System Default is selected, the tag is left blank and the filename is, for example, 15540-<time_stamp>-slot6-startup-backup.cfg. If User Specified is selected and hello is entered as the tag name, the filename is 15540-hello<YYYYMMDDHHMM>-slot6-startup.cfg, where YYYYMMDDHHMM is the time stamp.

The tag time stamp is ignored when the running configuration is saved as the startup configuration, because this operation is done on the NE itself and no backup file is saved on the CTM server.

slot_number_of_active_CPU is the slot number of the active CPU at the time of job execution. If the slot number cannot be obtained, the filename is 15540-<tag>-<time_stamp>-[ running | startup ].cfg.

running or startup is the memory backup option chosen.


Note The automatic backup files are named 155xx-<time_stamp>-<slot_number>-
[ running | startup ].cfg.


Step 6 For ONS 15600 SONET and ONS 15600 SDH NEs:

a. Click Next to display memory backup options. Select the category of data to back up (see Table 4-23 for details):

Provisioning data (is selected by default and is read-only)

Alarm data

PM data

b. Click Finish to initiate the memory backup procedure.

The configuration file is copied to the $CTMHOME/admin/<NE_system_ID>/15600-<tag_name>-<time_stamp>-backup.cfg file.


After scheduling the backup, look at the Job Monitor table (Administration > Job Monitor) to see the job status. If the job fails, the Additional Information field in the Job Monitor table provides more information.

If a memory backup job fails, the EMS raises an alarm. All prior memory backup failure EMS-generated alarms on an NE are cleared under the following conditions:

After a successful memory backup operation on the NE

When the operational state of the NE changes to Out of Service

Table 4-23 Field Descriptions for the Memory Backup Dialog Box 

Field
Description

NE Model

Select the NE type that you want to back up. The type you select determines the NEs that are displayed in the Network Elements area.

Available NEs

Use the Add and Remove buttons to move the NEs that you want to back up to the Selected NEs list, or to remove NEs from the list.

Job Comments

Enter comments about the backup, if needed.

Tag Name

Add a tag to the system-generated filename. If you select System Default, no tag name is added. If you select User Specified, you can enter a tag name.

Time (time zone)

Set a time for the backup. Click Now to begin backup immediately, or click At Time and specify when to begin backup, in 5-minute increments.

Note The time zone can be GMT, a user-defined offset from GMT, or local time, depending on what is specified in the User Preferences dialog box.

Memory Backup Dialog Box 2 for ONS 15530 and ONS 15540 NEs

Running Configuration

Copies the running configuration of the active CPU to the backup file. The backup file is saved in the $CTMHOME/admin/<NE_system_ID> directory. The CPU slot number is included in the filename. If you selected a tag name, the tag and time stamp are included in the filename. For example, if the active CPU is in slot 6, the filename is 15540-<tag>-<time_stamp>-slot6-running-backup.cfg.

Startup Configuration

Copies the startup configuration of the active CPU to the backup file. The startup configuration is stored in NVRAM and used when the NE reboots. The backup file is saved in the $CTMHOME/admin/<NE_system_ID> directory. The CPU slot number is included in the filename. If you selected a tag name, the tag and time stamp are included in the filename. For example, if the active CPU is in slot 6, the filename is 15540-<tag>-<time_stamp>-slot6-startup-backup.cfg.

Save Running Config as Startup Config on NE

Saves the running configuration as the startup configuration on the NE itself. The user-defined tag name is ignored. This is the equivalent of the write mem CLI command.

Memory Backup Dialog Box 2 for ONS 15600 SONET and ONS 15600 SDH NEs

Provisioning Data

(Read-only) Backs up the ONS 15600 provisioning data.

Alarm Data

If checked, the ONS 15600 alarm data is backed up.

PM Data

If checked, the 15-minute and 1-day PM data for the ONS 15600 is backed up.


4.5.2  Restoring Memory

Use the Memory Restore dialog box to restore provisioning and configuration information stored in the flash memory of the following NEs. (This information is backed up by using the Memory Backup dialog box.)

ONS 15216 EDFA2 (EDFA2 R2.3.0 and later)

ONS 15216 EDFA3

ONS 15310

ONS 15327

ONS 15454 SONET

ONS 15454 SDH

ONS 15530

ONS 15540 ESP and ESPx

ONS 15600 SONET

ONS 15600 SDH

CRS-1

XR 12000

Cisco MGX Voice Gateway


Note The latest ONS 15216 EDFA2 R2.4 hardware does not support memory restore to a software release other than 2.4.0. The ONS 15216 EDFA2 R2.3 hardware supports memory restore for NE software releases 2.3 and 2.4.



Note For the ONS 15530 and ONS 15540, the SNMP Community String table must have a valid write community string for the NE before memory can be restored. For more information, see Chapter 3, "Building the Network."



Note CTM R7.0 does not support memory restoration for the ONS 15302, ONS 15305, ONS 15501, ONS 15800, ONS 15801, ONS 15808, Catalyst 6509, MDS 9000, or Not Managed/Other Vendor NEs.



Step 1 In the Domain Explorer tree, select an NE that is assigned an In Service or Under Maintenance operational state.


Note Run the Memory Restore procedure for one NE at a time. Memory restore for preprovisioned or out-of-service NEs is not allowed.


Step 2 Choose Administration > Memory Restore. The Memory Restore dialog box opens.

Step 3 Enter the following information (see Table 4-25 for details):

NE model

NEs (select only one)

Source

Job comments

Time

Step 4 Depending on the type of NE, do one of the following:

For the ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SONET, or ONS 15454 SDH, proceed to Step 5.

For the ONS 15530 or ONS 15540, proceed to Step 6.

For the ONS 15600 SONET or ONS 15600 SDH, proceed to Step 7.

For the CRS-1, XR 12000, ONS 15216 EDFA2, ONS 15216 EDFA3, or Cisco MGX NEs, click Finish.

Step 5 For the ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SONET, or ONS 15454 SDH, click Next to verify the following file properties:

Node description

Node name

Node type

IP address

Software version

CTM performs a compatibility check. The following table lists the compatibility factors and the corresponding action. The restore operation is not allowed if the NEs are of different types or if the software version is incompatible.

Table 4-24 Compatibility Factors for Memory Restore 

Compatibility Factor
Action

Different NE type

Finish button is disabled; click Cancel.

Incompatible software version

Finish button is disabled; click Cancel.

Different node name

CTM displays a warning message. You can click Finish to proceed with the restore operation or Cancel to cancel the operation.

Different software version

CTM displays a warning message. You can click Finish to proceed with the restore operation or Cancel to cancel the operation.



Caution Restoring the memory of an NE using an incompatible or corrupted file might cause loss of traffic or loss of connectivity.

Step 6 For an ONS 15530 or ONS 15540:

a. Click Next to display the memory restore options. Select an option (see Table 4-25 for details):

Running configuration

Startup configuration

b. Click Finish to initiate the memory restore procedure.

Step 7 For the ONS 15600 SONET or ONS 15600 SDH:

a. Click Next to display the memory restore options. Select the category of data to restore (see Table 4-25 for details):

Provisioning data (is selected by default and is read-only)

Alarm data

PM data

b. Click Finish to initiate the memory restore procedure.


To view the results of the memory restore operation, open the Job Monitor table. For information about the Job Monitor table, see Monitoring Scheduled Tasks.

Table 4-25 Field Descriptions for the Memory Restore Dialog Box 

Field
Description

NE Model

Select the NE model that you want to restore. The model you select determines the NEs that are displayed in the Network Elements field.

Network Elements

Use the Add and Remove buttons to move the NE that you want to restore to the Selected NE list. You can run the Memory Restore procedure for only one NE at a time.

Source

Specify the location of the backup file that you want to use to restore the NE:

Click Local to browse a local client directory for the backup file.

Click Server to restore the file from the CTM server. The files shown are in the directory /opt/CiscoTransportManagerServer/admin/<NE_system_ID>.

Note The Server radio button is not active unless a file exists in that directory.

Click Remote TFTP Server Address to restore from another network server. (The Remote option is not supported for CTC-based NEs.) In the first field, enter the IP address of the TFTP server. In the second field, enter the fully qualified pathname of the backup file to be restored, relative to the tftpboot directory. TFTP must be configured and running on the network server. The Remote option is supported for the ONS 15216 EDFA2 (EDFA2 R2.3.0 and later).

Note If the Remote TFTP Server option is selected for the ONS 15216 EDFA, the backup file that you are restoring must have been saved in the default directory, such as the tftpboot directory on the remote TFTP server.

Note The tftpboot directory must have read-write access, or the restore job will fail. See Chapter 3, "Building the Network" for information about how to configure the tftp directory with read-write access.

Click Remote FTP Server Address to restore from any UNIX workstation that is running FTP. This option requires authentication. In the first field, enter the IP address of the FTP server. In the second field, enter the fully qualified pathname of the backup file to be restored, relative to the FTP directory. In the third field, enter the FTP username. In the last field, enter the FTP user password. The Remote FTP Server option is supported only for the ONS 15216 EDFA3.

Job Comments

Enter comments about the restore procedure, if needed.

Time (time zone)

Set a time for memory restore. Click Now to begin memory restore immediately, or click At Time and specify when to begin memory restore, in 5-minute increments.

Note The time zone can be GMT, a user-defined offset from GMT, or local time, depending on what is specified in the User Preferences dialog box.

Memory Restore Dialog Box 2 for ONS 15530 and ONS 15540 NEs

Running Configuration

Restores the currently running configuration of the NE.

Note Configuration file commands are added to the current running configuration on the NE. The running configuration is not replaced by the configuration file.

Startup Configuration

Restores the startup configuration of the NE. This operation entirely replaces the startup configuration file.

Memory Restore Dialog Box 2 for ONS 15600 SONET and ONS 15600 SDH NEs

Provisioning Data

(Read-only) Restores the ONS 15600 provisioning data.

Alarm Data

If checked, the ONS 15600 alarm data is restored.

PM Data

If checked, the 15-minute and 1-day PM data for the ONS 15600 is restored.


4.5.3  Viewing and Modifying ONS NE Service Properties

The NE Service pane in the Control Panel window allows you to view and update CTM server configuration information, which includes port information, timing parameters, and NE backup parameters. You can also stop or start an individual NE service instance.

All server configuration changes take effect when you save them, with the exception of changes to the CTM server port. Port information changes require that you restart the CTM server before the change takes effect. The NE Service pane contains the following tabs:

NE Poller—Allows you to change timing parameters and port information

NE AutoBackup—Allows you to configure automatic NE backup parameters

NE Manual Backup—Allows you to configure manual NE backup parameters


Note Table 4-26 describes the fields in the NE Service pane.



Note The NE service is not started as a process until you activate an NE for that particular service.


When you add a network partition, the NE service is not started automatically. It starts only when you add an NE to the network partition. When the last NE is removed from the network partition, the NE service is not stopped automatically. The NE service stops only when the network partition is deleted.


Note CTM is limited to running a maximum number of 23 Java processes. Enter the showctm command to view the current number of running processes.


4.5.3.1  Understanding the Unmanaged NE Service

Unmanaged NEs have their own NE service. This Unmanaged NE Service allows CTM to support unmanaged NE devices that are not in the Supported NE Table. Unmanaged NEs can be Cisco or non-Cisco devices. The Unmanaged NE Service is required for operations such as:

Creating manual links between managed and unmanaged NEs

Creating manual links between unmanaged NEs

Changing the operational state of unmanaged NEs


Note Passive NEs such as the ONS 15216 EDFA1 are not considered unmanaged NEs.



Note MDS 9000 NEs are managed like unmanaged NEs by CTM. NEs discovery includes only ICMP ping.


4.5.3.2  Changing Timing Parameters

Use the NE Service pane to tune timing parameters and accommodate different CTM server-to-NE connectivity scenarios. When timing parameters are tuned, network utilization and CTM server load are optimized. As a rule, timing parameters increase as the network slows.


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

Step 2 In the Control Panel window, click NE Service to open the NE Service pane. Table 4-26 describes the fields in the NE Service pane.

Step 3 Click the NE Poller tab. Enter the following information:

CTM server port

NE health poll interval

Step 4 In the Control Panel window, expand the NE Service and click an NE. Table 4-27 describes the fields in the ONS NE Service pane.

Step 5 In the Resync Scheduling area of the ONS NE Service pane, enter the interval at which the configuration is retrieved and processed. This field is not available for all NEs.


Note The default values are adequate for most network configurations. Decreasing the values of the parameters could have an adverse impact on server performance.


Step 6 Click Save. Changes take effect immediately.


Table 4-26 Field Descriptions for the NE Service Pane 

Field
Subfield
Description
NE Poller Tab

Port Information

CTM Server Port

Displays the TCP port number of the CTM server. The Active field displays the current port; the After Restart field displays the port that is active after the server is rebooted.

Timing Parameters

NE Health Poll Interval

Displays the NE polling interval (in seconds). The Cisco default is 240 seconds (4 minutes).

NE AutoBackup Tab

Select Modify Mode

Allows you to specify whether the automatic backup should apply to a specific NE model (ONS 15216 EDFA2 [R2.3.0 and later], ONS 15216 EDFA3, ONS 15530, ONS 15540 ESP, ONS 15540 ESPx, CRS-1, XR 12000, or MGX) or to all applicable NE models.

Configuration Parameters

NE Model

If NE Model is selected under Select Modify Mode, this field allows you to specify the NE model that will be backed up automatically.

Enable Auto Backup

If checked, the system automatically backs up all NE models, or a specific NE model. When NE AutoBackup State is set to Enabled, an entry is added to the Job Monitor table with a new job ID and a new task ID for each NE. Scheduled Time is set to the selected autobackup time and Task Status is set to Queued. When the autobackup time is reached and the task begins, Task Status is set to Running. After the backup is complete, Task Status is set back to Queued and Scheduled Time is reset to the time and date of the next scheduled backup time. When NE AutoBackup State is set to Disabled, Task Status is set to Cancelled. The default state is Disabled.

Backup Frequency

(Read-only) Indicates the interval in days between subsequent backups. The backup frequency is set to 1, meaning that a backup is performed every day at the time specified in the Backup Time field.

Number of Backup Copies Retained

Allows you to specify the number of backup copies to keep. The valid range is from 1 to 50 backup copies; the Cisco default is 7. Only automatic backup copies count toward the total number of backup copies saved; manual backup copies do not count toward the total.

For ONS 15530 and ONS 15540 NEs, the total number of backup copies includes both running and startup configuration files. For example, if you want to keep 7 copies of each configuration file, you should set the number of copies to 14.

Each time CTM creates a new backup file, it checks the existing number of backup copies. CTM deletes files as needed, beginning with the oldest file, so as not to exceed the specified number of backup copies to keep.

Backup Time

Allows you to set the time when the automatic backup will be performed.

NE Manual Backup Tab

Select Modify Mode

Allows you to specify whether the manual backup should apply to a specific NE model (ONS 15216 EDFA2 [R2.3.0 and later], ONS 15216 EDFA3, ONS 15530, ONS 15540 ESP, ONS 15540 ESPx, CRS-1, MGX, or XR 12000) or to all applicable NE models.

Configuration Parameters

NE Model

If NE Model is selected under Select Modify Mode, this field allows you to specify the NE model that will be backed up manually.

No. of Backup Copies Retained

Allows you to specify the number of backup copies to keep (the Cisco default is 7).

Each time CTM creates a new backup file, it checks the existing number of backup copies. CTM deletes files as needed, beginning with the oldest file, so as not to exceed the specified number of backup copies to keep.


Table 4-27 Field Descriptions for the ONS NE Service Pane 

Field
Description
Status Tab

Service Status

Displays the current status of the service: Active or Not Active. By default, the status is Not Active.

Note The NE service can take up to 60 seconds to initialize after the GUI status has changed to indicate that the service is up. The status is an indication of the successful initiation of the service startup, not successful initialization.

Service Action

Allows you to stop or start a process. Notice that the Service Action button toggles between Activate and Deactivate, and that the Service Status field changes accordingly.

Threshold

Displays the maximum number of NEs that each NE service instance can manage. The threshold depends on the NE type, as follows:

ONS 15216 NE Service can manage up to 1000 ONS 15216 NEs.

ONS 15302 NE Service can manage up to 1000 ONS 15302 NEs.

ONS 15305 NE Service can manage up to 1000 ONS 15305 NEs.

ONS 155xx NE Service can manage up to 1000 ONS 155xx NEs.

ONS 15800 NE Service can manage up to 1000 ONS 15800 NEs.

ONS 15801 NE Service can manage up to 1000 ONS 15801 NEs.

ONS 15808 NE Service can manage up to 1000 ONS 15808 NEs.

CRS-1 NE Service can manage up to 1000 CRS-1 NEs.

Unmanaged NE Service can manage up to 500 unmanaged NEs.

Catalyst 6509 NE Service can manage up to 1000 Catalyst 6509 NEs.

MDS 9000 NE Service can manage up to 500 MDS 9000 NEs.

MGX Voice Gateway NE Service can manage up to 400 MGX devices.

XR 12000 NE Service can manage up to 1000 XR 12000 devices.

Resync Scheduling (not applicable to CRS-1, unmanaged, Catalyst 6509, MDS 9000, MGX, or XR 12000 NEs)

Allows you to specify a schedule for database resynchronization for each NE model. A schedule consists of the following configurable parameters:

Days of the week to run: All, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. Check the check box next to the day(s) to run the configuration resynchronization.

Time of day to initiate the resynchronization, in HH:MM AM/PM format (specific format based on locale).

Interval between synchronizations, in HH:MM format. The maximum interval is 24:00; the minimum is 5:00. The resync interval is calculated only until the end of the day. The schedule for the next day takes effect after the end of the current day. For example, if you choose Wednesday with a start time of 10:00 AM and an interval of 6 hours, the resync occurs at 10:00 AM, 4:00 PM, and 10:00 PM on Wednesdays.

After you set the time interval between synchronizations, the CTM server will resynchronize the database with the configuration changes from the last resync time. This synchronizes the database with NE, cards, and line configuration information.

Note The Last Resync field shows when the NE was last synchronized.

Enable BGP Discovery (applicable to CRS-1 and XR 12000 NEs)

Allows you to enable or disable BGP discovery. By default, BGP discovery is enabled. Disable BGP discovery before activating an NE so that neighbors will not be discovered.

NE Service Instance

Start Service Instance, Stop Service Instance

Allows you to stop or start an individual NE service instance. If you click Start Service Instance, the service status changes to Running. If you click Stop Service Instance, the status changes to Stopped.

The list of managed NEs shows which NEs are being managed by the selected service instance. If you stop the specified service instance, the NEs in the list are no longer managed.

Debug Tab

Overall Logging

Enable—Choose the Enable radio button to enable logging. When you choose the Enable radio button the debug modules in the Available list become selectable.

Disable—Choose the Enable radio button to disable logging. When you choose the Disable radio button the debug modules in the Available list become grayed out and you cannot make any selections from the Available list.

Debug Modules

Available—Select one or more Debug Modules in the Available list and click Add to move them to the Selected list.


Tip Hold down the Shift key to select more than one debug module sequentially. To select multiple debug modules non-sequentially, hold down the Ctrl key on your keyboard while using your mouse to click on multiple debug modules.


Selected—Select one or more Debug Modules in the Selected list and click Remove to move them to the Available list.

Save button

After making your selections, click Save. Changes take effect immediately.


4.5.3.3  Configuring Automatic NE Backup Parameters

CTM can be configured to automatically back up ONS 15216 EDFA2, ONS 15216 EDFA3, ONS 15530, ONS 15540 ESP, ONS 15540 ESPx, CRS-1, MGX, and XR 12000 NEs once a day.

Automatic backup files are saved in the following locations and have the following names:

$CTMHOME/admin/<NE_system_ID>/15216-<YYYYMMDDHHMM>-auto.cfg

$CTMHOME/admin/<NE_system_ID>/15310-<YYYYMMDDHHMM>-auto.cfg

$CTMHOME/admin/<NE_system_ID>/Cisco_ONS_15327-<YYYYMMDDHHMM>-auto.cfg

$CTMHOME/admin/<NE_system_ID>/15454-<YYYYMMDDHHMM>-auto.cfg

$CTMHOME/admin/<NE_system_ID>/[ 15530 | 15540 ]-<YYYYMMDDHHMM>-
<Active_CPU_slot_number>-[ running | startup ]-auto.cfg

$CTMHOME/admin/<NE_system_ID>/15600-<YYYYMMDDHHMM>-auto.cfg

$CTM_HOME/admin/<NE_system_ID>/CRS1-<USER_TAG>-<DATE_AND_TIME>-auto.cfg

$CTM_HOME/admin/<NE_system_ID>/CTM-<YYYYMMDDHHMM>-auto.cfg

$CTM_HOME/admin/<NE_system_ID>/XR 12000-<USER_TAG>-<DATE_AND_TIME>-auto.cfg

where:

<YYYYMMDDHHMM> is the date of the backup:

YYYY is the four-digit year

MM is the two-digit month

DD is the two-digit day

HH is the two-digit hour (in 24-hour format)

MM is the two-digit minute

For example, 4:01 p.m. on September 29, 2004 is represented as 200409291601.

<Active_CPU_slot_number> is the slot number of the active CPU at the time of job creation.

[ running | startup ] indicates whether the backup is of the NE's running configuration or startup configuration.

<USER_TAG> is the user-specified tag name (for CRS-1).

<DATE_AND_TIME> is the year, month, day, and time (for CRS-1). For example, 20030610151159 means that the file was backed up on June 10, 2003 at 3:11:59 PM.


Note Automatic backup is not available for the ONS 15501, ONS 15800, ONS 15801, ONS 15808, Catalyst 6509, or MDS 9000.


Use the NE Service pane to set automatic NE backup parameters.


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

Step 2 In the Control Panel window, click NE Service to open the NE Service pane. Click the NE AutoBackup tab. Table 4-26 describes the fields in the NE AutoBackup tab.

Step 3 Enter the following information:

Select Modify Mode

NE Model

Enable Auto Backup

Backup Frequency

No. of Backup Copies Retained

Backup Time

Step 4 Click Save. Changes take effect immediately; however, the backup already scheduled for the next 24 hours remains in effect. A backup with the new parameters will occur after the previously scheduled backup runs.


Note If the time you scheduled for the backup is prior to the current time of the current day, a backup for the current day will be scheduled for immediate execution. Otherwise, backups for the current day and subsequent days will occur at the specified time.




Note To verify whether CTM is automatically backing up the NE, go to the Job Monitor table, verify that the task is listed, and check its task status. If automatic backup for an NE failed, the task status will be "Failed." This failure is logged in the Audit Log and an alarm is generated.



Note If the CTM server restarts after the scheduled automatic backup time for that day, CTM automatically schedules a backup for all ONS 15530, and ONS 15540 NEs to take place five to ten minutes after the restart. Conversely, if the server restarts before the scheduled backup time for that day, the backup occurs at the regularly scheduled time. This behavior ensures that a backup is performed for each NE at least once a day.

For example, if the automatic backup time is set for 2:00 a.m. and the CTM server restarts at 8:00 p.m., the server schedules a backup five to ten minutes after the restart because the backup time is earlier than the restart time on the same day. As another example, if the automatic backup time is set for 11:00 p.m. and the CTM server restarts at 8:00 p.m., the server waits until 11:00 p.m. to run the backup because the backup time is later than the restart time.

An entry is added to the Audit Log for each successful completion or failed NE autobackup task.


4.5.3.4  Configuring Manual NE Backup Parameters

Use the NE Service pane to set manual NE backup parameters.


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

Step 2 In the Control Panel window, click NE Service to open the NE Service pane. Click the NE Manual Backup tab. Table 4-26 describes the fields in the NE Manual Backup tab.

Step 3 Enter the following information:

Select Modify Mode

NE Model

No. of Backup Copies Retained

Step 4 Click Save. Changes take effect immediately; however, the backup already scheduled for the next 24 hours remains in effect. A backup with the new parameters will occur after the previously scheduled backup runs.


4.5.4  Viewing and Modifying CTC Based Network Service Properties

The Network Service pane in the Control Panel window allows you to view and update CTM server configuration information for CTC based NEs, which includes port information, timing parameters, and NE backup parameters. You can also stop or start an individual NE service instance.

All server configuration changes take effect when you save them, with the exception of changes to the CTM server port. Port information changes require that you restart the CTM server before the change takes effect. The Network Service pane contains the following tabs:

NE Poller—Allows you to change timing parameters and port information

NE AutoBackup—Allows you to configure automatic NE backup parameters

NE Manual Backup—Allows you to configure manual NE backup parameters


Note Table 4-28 describes the fields in the Network Service pane.



Note The Network Service is not started as a process until you activate an NE for that particular service.


When you add a network partition, the NE service does not start automatically. It starts only when you add an NE to the network partition. When the last NE is removed from the network partition, the NE service does not stop automatically. The NE service stops only when the network partition is deleted.


Note CTM is limited to running a maximum number of 23 Java processes. Enter the showctm command to view the current number of running processes.


4.5.4.1  Changing Timing Parameters

Use the Network Service pane to tune timing parameters and accommodate different CTM server-to-NE connectivity scenarios. When timing parameters are tuned, network utilization and CTM server load are optimized. As a rule, timing parameters increase as the network slows.


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

Step 2 In the Control Panel window, click Network Service to open the Network Service pane. Table 4-28 describes the fields in the Network Service pane.

Step 3 Click the NE Poller tab. Enter the following information:

CTM server port

NE health poll interval

Step 4 In the Control Panel window, expand the Network Service and click an NE. Table 4-29 describes the fields in the CTC-Based (SONET/SDH) Network Service pane.

Step 5 In the Resync Scheduling area of the ONS Network Service pane, enter the interval at which the configuration is retrieved and processed. This field is not available for all NEs.


Note The default values are adequate for most network configurations. Decreasing the values of the parameters could have an adverse impact on server performance.


Step 6 Click Save. Changes take effect immediately.


Table 4-28 Field Descriptions for the Network Service Pane 

Field
Subfield
Description
NE Poller Tab

Port Information

CTM Server Port

Displays the TCP port number of the CTM server. The Active field displays the current port; the After Restart field displays the port that is active after the server is rebooted.

Timing Parameters

NE Health Poll Interval

Displays the NE polling interval (in seconds). The Cisco default is 240 seconds (4 minutes).

CTC IIOP Port Configuration

CTC IIOP Port Range

Displays CTC IIOP ports or a range of ports for CTC-based NE Service that have been selected to be configured. When all ports have been removed in the CTC IIOP Selection window, the CTC IIOP Port Range field will display a zero.

Edit CTC IIOP Port Range button

Click the Edit CTC IIOP Port Range button to open the CTC IIOP Selection window. The CTC IIOP Selection window allows you to configure CTC IIOP ports, or a range of ports for CTC-based NE Service.

Note Table 4-30 describes the fields in the CTC IIOP Selection window.

NE AutoBackup Tab

Select Modify Mode

Allows you to specify whether the automatic backup should apply to a specific NE model (ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, or ONS 15600 SDH) or to all applicable NE models.

Configuration Parameters

NE Model

If NE Model is selected under Select Modify Mode, this field allows you to specify the NE model that will be backed up automatically.

Enable Auto Backup

If checked, the system automatically backs up all NE models, or a specific NE model. When NE AutoBackup State is set to Enabled, an entry is added to the Job Monitor table with a new job ID and a new task ID for each NE. Scheduled Time is set to the selected autobackup time and Task Status is set to Queued. When the autobackup time is reached and the task begins, Task Status is set to Running. After the backup is complete, Task Status is set back to Queued and Scheduled Time is reset to the time and date of the next scheduled backup time. When NE AutoBackup State is set to Disabled, Task Status is set to Cancelled. The default state is Disabled.

Backup Frequency

(Read-only) Indicates the interval in days between subsequent backups. The backup frequency is set to 1, meaning that a backup is performed every day at the time specified in the Backup Time field.

No. of Backup Copies Retained

Allows you to specify the number of backup copies to keep. The valid range is from 1 to 50 backup copies; the Cisco default is 7. Only automatic backup copies count toward the total number of backup copies saved; manual backup copies do not count toward the total.

Each time CTM creates a new backup file, it checks the existing number of backup copies. CTM deletes files as needed, beginning with the oldest file, so as not to exceed the specified number of backup copies to keep.

Backup Time

Allows you to set the time when the automatic backup will be performed.

Backup Data (available only if ONS 15600 SONET or SDH is selected as the NE model)

Allows you to select provisioning data, alarm data, PM data, and/or Audit Log data to back up.

NE Manual Backup Tab

Select Modify Mode

Allows you to specify whether the manual backup should apply to a specific NE model (ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, or ONS 15600 SDH) or to all applicable NE models.

Configuration Parameters

NE Model

If NE Model is selected under Select Modify Mode, this field allows you to specify the NE model that will be backed up manually.

No. of Backup Copies Retained

Allows you to specify the number of backup copies to keep (the Cisco default is 7).

Each time CTM creates a new backup file, it checks the existing number of backup copies. CTM deletes files as needed, beginning with the oldest file, so as not to exceed the specified number of backup copies to keep.


Table 4-29 Field Descriptions for the CTC-Based (SONET/SDH) Network Service Pane 

Field
Description
Status Tab

Service Status

Displays the current status of the service: Active or Not Active. By default, the status is Not Active.

Note The NE service can take up to 60 seconds to initialize after the GUI status has changed to indicate that the service is up. The status is an indication of the successful initiation of the service startup, not successful initialization.

Service Action

Allows you to stop or start a process. Notice that the Service Action button toggles between Activate and Deactivate, and that the Service Status field changes accordingly.

Threshold

Displays the maximum number of NEs that each NE service instance can manage. The threshold depends on the NE type, as follows:

ONS 15310 CL/ONS 15327/ONS 15454 SONET/ONS 15600 SONET NE Service can manage up to 400 ONS 15310 CL, ONS 15327, ONS 15454 SONET, or ONS 15600 SONET NEs (for NE releases earlier than R5.0).

Note For NE release 5.0 or later in a large or high-end configuration, the NE Service can manage up to 500 NEs.

ONS 15454 SDH/ONS 15600 SDH NE Service can manage up to 600 ONS 15454 SDH or ONS 15600 SDH NEs.

Resync Scheduling

Allows you to specify a schedule for database resynchronization for each NE model. A schedule consists of the following configurable parameters:

Days of the week to run: All, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. Check the check box next to the day(s) to run the configuration resynchronization.

Time of day to initiate the resynchronization, in HH:MM AM/PM format (specific format based on locale).

Interval between synchronizations, in HH:MM format. The maximum interval is 24:00; the minimum is 5:00. The resync interval is calculated only until the end of the day. The schedule for the next day takes effect after the end of the current day. For example, if you choose Wednesday with a start time of 10:00 AM and an interval of 6 hours, the resync occurs at 10:00 AM, 4:00 PM, and 10:00 PM on Wednesdays.

After you set the time interval between synchronizations, the CTM server will resynchronize the database with the configuration changes from the last resync time. This synchronizes the database with NE, cards, and line configuration information.

Note The Last Resync field shows when the NE was last synchronized.

Bandwidth Utilization Report

Check the Enable Bandwidth Data Service Provisioning (DSP) check box to enable the bandwidth check during L2 service provisioning. The bandwidth utilization report shows available and used bandwidth for each L2 topology. This report can be used during L2 service provisioning to verify whether the requested Committed Information Rate (CIR) is available on the topology. Based on the report, a warning is returned if there is not enough bandwidth available for a drop port. Be careful not to oversubscribe the bandwidth.

Robust Fault Synchronization

Allows you to enable or disable the robust fault synchronization for the ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH.

BSLR-Ring/MS-SPRing Exercise Interval

Allows you to set the BLSR or MS-SPRing exercise interval. The interval is measured in seconds. The Cisco default is 60 seconds.

Audit Trail Collection Interval

Allows you to set the audit trail collection interval. The collection interval is measured in minutes.

L2 Service Resync Delay

Allows you to configure the delay after which CTM performs a Cisco IOS configuration synchronization on ML cards to keep the NE and the CTM Data Provisioning Service synchronized. This operation synchronizes the L2 topology.

Full Cisco IOS configuration synchronization is performed automatically by CTM to keep the NE and the CTM Data Provisioning Service synchronized. Full configuration resynchronization might be delayed depending on CTM server usage. For the CTM server deployed as the monitoring server, the recommended value for the delay parameter is 120 seconds. For the CTM server deployed as provisioning server, the recommended value for the delay parameter is 10 minutes (600 seconds).

ENEs List Poll Interval

Time interval in which all CTC-based GNEs in CTM need to refresh their list of ENEs. The list of ENEs for each GNE is obtained and compared with the existing ENE list. If there are any changes to the ENE list, topology changes are carried out so that the Domain Explorer will reflect the current topology with correct GNE and ENE icons.


Debug Tab

Overall Logging

Enable—Choose the Enable radio button to enable logging. When you choose the Enable radio button the debug modules in the Available list become selectable.

Disable—Choose the Enable radio button to disable logging. When you choose the Disable radio button the debug modules in the Available list become grayed out and you cannot make any selections from the Available list.

Debug Modules

Available—Select one or more Debug Modules in the Available list and click Add to move them to the Selected list.


Tip Hold down the Shift key to select more than one debug module sequentially. To select multiple debug modules non-sequentially, hold down the Ctrl key on your keyboard while using your mouse to click on multiple debug modules.


Selected—Select one or more Debug Modules in the Selected list and click Remove to move them to the Available list.

Save button

After making your selections, click Save. Changes take effect immediately.


4.5.4.2  Configuring Automatic NE Backup Parameters

CTM can be configured to automatically back up ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15530, ONS 15600 SONET, and ONS 15600 SDH once a day.

Automatic backup files are saved in the following locations and have the following names:

$CTMHOME/admin/<NE_system_ID>/15310-<YYYYMMDDHHMM>-auto.cfg

$CTMHOME/admin/<NE_system_ID>/Cisco_ONS_15327-<YYYYMMDDHHMM>-auto.cfg

$CTMHOME/admin/<NE_system_ID>/15454-<YYYYMMDDHHMM>-auto.cfg

$CTMHOME/admin/<NE_system_ID>/15600-<YYYYMMDDHHMM>-auto.cfg

$CTM_HOME/admin/<NE_system_ID>/CTM-<YYYYMMDDHHMM>-auto.cfg

where:

<YYYYMMDDHHMM> is the date of the backup:

YYYY is the four-digit year

MM is the two-digit month

DD is the two-digit day

HH is the two-digit hour (in 24-hour format)

MM is the two-digit minute

For example, 4:01 p.m. on September 29, 2004 is represented as 200409291601.

<Active_CPU_slot_number> is the slot number of the active CPU at the time of job creation.

[ running | startup ] indicates whether the backup is of the NE's running configuration or startup configuration.


Note Automatic backup is not available for the ONS 15501, ONS 15800, ONS 15801, ONS 15808, Catalyst 6509, or MDS 9000.


Use the Network Service pane to set automatic NE backup parameters.


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

Step 2 In the Control Panel window, click Network Service to open the Network Service pane. Click the NE AutoBackup tab. Table 4-28 describes the fields in the NE AutoBackup tab.

Step 3 Enter the following information:

Select Modify Mode

NE Model

Enable Auto Backup

Backup Frequency

No. of Backup Copies Retained

Backup Time

Backup Data (available only if ONS 15600 SONET or SDH is selected as the NE model)

Step 4 Click Save. Changes take effect immediately; however, the backup already scheduled for the next 24 hours remains in effect. A backup with the new parameters will occur after the previously scheduled backup runs.



Note To verify whether CTM is automatically backing up the NE, go to the Job Monitor table, verify that the task is listed, and check its task status. If automatic backup for an NE failed, the task status will be "Failed." This failure is logged in the Audit Log and an alarm is generated.



Note If the CTM server restarts after the scheduled automatic backup time for that day, CTM automatically schedules a backup for all ONS 15327, ONS 15454 SONET, ONS 15530, and ONS 15540 NEs to take place five to ten minutes after the restart. Conversely, if the server restarts before the scheduled backup time for that day, the backup occurs at the regularly scheduled time. This behavior ensures that a backup is performed for each NE at least once a day.

For example, if the automatic backup time is set for 2:00 a.m. and the CTM server restarts at 8:00 p.m., the server schedules a backup five to ten minutes after the restart because the backup time is earlier than the restart time on the same day. As another example, if the automatic backup time is set for 11:00 p.m. and the CTM server restarts at 8:00 p.m., the server waits until 11:00 p.m. to run the backup because the backup time is later than the restart time.

An entry is added to the Audit Log for each successful completion or failed NE autobackup task.


4.5.4.3  Configuring Manual NE Backup Parameters

Use the Network Service pane to set manual NE backup parameters.


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

Step 2 In the Control Panel window, click Network Service to open the Network Service pane. Click the NE Manual Backup tab. Table 4-28 describes the fields in the NE Manual Backup tab.

Step 3 Enter the following information:

Select Modify Mode

NE Model

No. of Backup Copies Retained

Step 4 Click Save. Changes take effect immediately; however, the backup already scheduled for the next 24 hours remains in effect. A backup with the new parameters will occur after the previously scheduled backup runs.


4.5.4.4  CTC IIOP Port Configuration

The CTC IIOP Selection dialog box allows you to configure individual CTC IIOP ports, or a range of CTC IIOP ports, for CTC-based NE services.

Typically you would configure a specific CTC IIOP port (or a range of ports) if you have a firewall between the CTM server and the NE.

The number of ports configured must equal the number of CTC-based NE services, unless you have SSLIOP configured on the NE. If you have SSLIOP configured on the NE, each NE service requires two ports (instead of one port): one for IIOP and one for SSLIOP.


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

Step 2 In the Control Panel window, click Network Service to open the Network Service pane. Table 4-26 describes the fields in the Network Service pane.

Step 3 Click the NE Poller tab.

Step 4 Click the Edit CTC IIOP Port Range button to open the CTC IIOP Selection window. The CTC IIOP Selection window allows you to select CTC IIOP ports or a range of ports for CTC-based NE service. Table 4-30 describes the fields in the CTC IIOP Selection window.

Table 4-30 Field Descriptions for the CTC IIOP Selection Window 

Field
Subfield
Description

CTC IIOP Port Configuration

CTC IIOP Port Range

Displays CTC IIOP ports or a range of ports for CTC-based NE Service that have been selected to be configured. When all ports have been removed in the CTC IIOP Selection window, the CTC IIOP Port Range field will display a zero.

Edit CTC IIOP Port Range button

Click the Edit CTC IIOP Port Range button to open the CTC IIOP Selection window. The CTC IIOP Selection window allows you to configure CTC IIOP ports, or a range of ports for CTC-based NE Service.

The CTC IIOP Selection window displays the following fields:

From/To—Enter a port range by specifying the initial value in the From text-field and the end value in the To (optional) text-field. You can specify a single port by entering the port value in the From text-field and leaving the To text-field blank. The valid range for the From/To fields is 0 through 65,535.

Add Port button—Click the Add Port button to add the ports specified in the From/To fields to the Selected Ports list. Ports listed in the Selected Port list will appear in the CTC IIOP Port Range field.

Deleted Port—Displays the list of ports to be deleted from the CTC IIOP Port Range.

Selected Port—Displays the list of ports to be added to the CTC IIOP Port Range.

Remove button—Select a port in the Selected Ports list and click the Remove button to move the port to the Deleted Port list. Ports listed in the Deleted Port list will not appear in the CTC IIOP Port Range.

OK button—Click OK to save the changes you have made and close the CTC IIOP Selection window.


Step 5 Enter the port values.


Note It is possible to specify a single port (leaving the To text-field blank) or a port range specifying the initial value (From text-field) and the end value (To text-field).



Note The ports will be added in the Selected Port list in an ascending order.


Step 6 Click the Add Port button to add the entered ports. The ports are added to the Selected Port list in ascending order.


Tip You can remove ports from the Selected Ports list by selecting the port you want to remove, and clicking the Remove button. The port then appears in the Deleted Port list. You can add ports into the Selected Ports list by selecting the port you want to add in the Deleted Port list, and clicking the Add button. The port then appears in the Selected Port list.


Step 7 Click OK to close the CTC IIOP Selection window. The values displayed in the Selected Port are formatted and displayed in the CTC IIOP Port Range field.


Caution The NE service will not start if the ports you select are already in use by the server. Check that the port values you select in the CTC IIOP Selection window are not already in use by the server before saving your changes.

Step 8 Click Save to save your changes. Changes take effect immediately.


4.5.5  Viewing and Modifying Service Instance Properties

The Network Service Instance pane in the Control Panel window allows you to view the list of NEs managed from the service instance. The Network Service Instance pane also allows you to activate or deactivate debug logging on selected NEs.


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

Step 2 In the Control Panel window, click Network Service to open the Network Service pane. Expand the Network Service and click Network Service Instance. Table 4-31 describes the fields in the Network Service Instance pane.

Table 4-31 Field Descriptions for the Network Service Instance Pane 

Field
Description
Status

Service Status

Displays the current status of the service: Active or Not Active. By default, the status is Not Active.

The network service can take up to 60 seconds to initialize after the GUI status has changed to indicate that the service is up. The status is an indication of the successful initiation of the service startup, not successful initialization.

Start Service Instance, Stop Service Instance

Allows you to stop or start an individual network service instance. If you click Start Service Instance, the service status changes to Running. If you click Stop Service Instance, the status changes to Stopped.

The list of managed NEs shows which NEs are being managed by the selected service instance. If you stop the specified service instance, the NEs in the list are no longer managed.

Dump Cache button

Click the Dump Cache button to export the cache (memory) information of the selected service instance to a log file. This feature applies only to CTC-based NE service instances.

Note Dump cache is not applicable to CRS-1 and XR 12000 NEs because all information is saved in the database. It is not required to log cache into the log files.

Debug Table button

Click the Debug Table button to open the CTM Module Level Debug Table window. See Viewing the CTM Module Level Debug Table.

Overall Logging for the Instance

Enable—Choose the Enable radio button to enable logging. When you choose the Enable radio button the debug modules in the Available list become selectable.

Disable—Choose the Enable radio button to disable logging. When you choose the Disable radio button the debug modules in the Available list become grayed out and you cannot make any selections from the Available list.

Managed NEs

NE ID

Displays the ID name of the selected NE.

IP Address

Displays the IP address of the selected NE.

NE State

Displays the state of the selected NE.

Communication State

Displays the current connectivity state between CTM and the selected NE. Values are Available or Unavailable.

Subnet ID

Displays the name of the subnetwork associated with the selected NE.

Debug Option

Displays whether the debug option is enabled or disabled for the selected NE.


4.5.5.1  Viewing the CTM Module Level Debug Table

The CTM Module Level Debug table displays the debug state of the selected NEs, and it lists the modules for which debugging is active.


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

Step 2 In the Control Panel window, click Network Service to open the Network Service pane.

Step 3 Expand the Network Service and click Network Service Instance.

Step 4 Select one or more managed NEs from the managed NEs table.

Step 5 Click the Debug Table button. The CTM NE Module Level Debug Table appears. Table 4-32 describes the fields in the CTM Module Debug table.


Table 4-32 Field Descriptions for the CTM Module Level Debug Table 

Column Name
Description

NE ID

Displays the ID name of the selected NE.

Debug State

Displays the debug state (enabled or disabled).

Debug Modules

Displays a list of debug modules active on the selected node.


4.5.5.2  Configuring the NE Logging Options

The Network Element Logging Options window allows you to modify the debug state for selected NEs.


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

Step 2 In the Control Panel window, click Network Service to open the Network Service pane.

Step 3 Expand the Network Service and click Network Service Instance.

Step 4 Select one or more managed NEs from the managed NEs table.

Step 5 Click the Debug Table button. The CTM NE Module Level Debug Table appears.

Step 6 Select the Open Debug Dialog icon to open the Network Element Logging Options window. Table 4-33 describes the fields in the Network Element Logging Options window.

Table 4-33 Field Descriptions for the Network Element Logging Options Window 

Field
Description
Overall Logging

Enable

Select Disable to move all modules from the Selected Modules list to the Available Modules list.

Disable

Check the Disabled checked box to prevent modules from being selected for debugging.

Apply to All NEs

Check the Apply to All check box to apply all the modules to the NEs selected in the CTM Module Debug table.

Debug Modules

Available

Displays the modules available for debugging that have not been selected for debugging.

Selected

Displays the modules selected for debugging.


Step 7 Click Save to save the NE logging options.


4.5.6  Backing Up Client Files

Use the Backup File dialog box to view a list of NE configuration files that were created during routine backups and saved on the CTM server from the NEs. You can select one or more files from the list and save them to a local client workstation.


Step 1 In the Domain Explorer window, choose Administration > Memory Backup Upload. The Backup File dialog box opens. The following table provides descriptions.

Step 2 In the Files area, select backup files from the list. To select multiple files, hold down the Ctrl key on your keyboard while using your mouse to click files. Click Select All to select all files in the list.

Step 3 In the Upload Location text box, specify where you want to save the backup files on the client. Click Browse to choose a client location different from the default.

Step 4 Click Upload to upload the selected backup files to the specified client workstation.


Table 4-34 Field Descriptions for the Backup File Dialog Box 

Field
Description

Files

Lists the backup files that are available on the server.

Upload Location

Allows you to specify where you want to save the backup files on the client. The default location is <CTM_client_installation_directory>\admin\ or <CTM_client_installation_directory>/admin/. Click Browse to choose a different location.

Upload button

Uploads the selected backup files to the specified client location.

Select All button

Selects all of the backup files in the list.

Cancel button

Replaces any changes to user-defined fields with the previous values and closes the dialog box.

Help button

Launches the online help for the Backup File dialog box.


4.5.7  Restoring Server Configuration Files


Step 1 Log into the server workstation as the root user.

Step 2 On the command line, enter the following commands:

cd/opt/CiscoTransportManagerServer/bin
./restore_config.sh <backup_file_location> <log_directory> <ISHA>


Note If the server is a high availability (HA) server, the ISHA value is 1. If the server is not an HA server, the ISHA value is 0.



4.5.8  Initializing the Node Resync Process


Step 1 In the Diagnostic Center, from the Hierarchy pane:

Double-click or drag the network to the right-hand pane to display the diagnostics at the node level and select a node.

Double-click or drag the node to the right-hand pane to display the diagnostics at the node level.

By default, the Diagnostics tab is selected. The Node Diagnostics window is displayed.

Step 2 Choose Level 1 or Level 2 options from the Node Resync pane:

Level 1—Resolves inconsistencies between the switch and equipment manager as well as between equipment manager and segment tables.

Level 2—Retrieves the full connection file from the switch and resolves inconsistencies between the equipment manager and equipment manager caches as well as between equipment caches and databroker caches. It also resolves inconsistencies between equipment manager and segment tables. This option is automatically used if the number of inconsistencies is large.

Step 3 Click Resync to begin the node resync process.

Step 4 Verify the results of the node resync process from the Node Resync Result area.


4.5.9  Configuring Nodes for Database Restore—ONS 15600

Use the Configure Node dialog box to configure the selected ONS 15600 SONET or ONS 15600 SDH node. This feature is essentially a database restore without the check for a matching node ID, software version, and IP address. Additionally, you can specify that a new IP address overrides the IP address in the database. When the node reboots after the database has been downloaded, it uses the new IP address you specified. Only the provisioning database is restored from the ONS 15600 database file, which can contain provisioning, alarm, PM, and audit databases.


Step 1 In the Domain Explorer tree, select an ONS 15600 SONET or ONS 15600 SDH NE that is assigned an In Service or Under Maintenance operational state. You cannot configure nodes for preprovisioned or out-of-service NEs.

Step 2 Choose Configuration > CTC-based SONET NEs or CTC-based SDH NEs > Configure Node. The Configure Node dialog box opens. Table 4-35 provides descriptions.

Step 3 Enter the following information:

NE model

Selected NE

Source