Cisco Prime Optical User Guide, 10.7

Viewing and Modifying Database Properties

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

• Configuration—Defines the values used by the Prime Optical server to log in to the Oracle database. Fields are grouped into two columns: Activated After Restart and Active. The Activated After Restart column shows the values that the Prime Optical server uses after the server is restarted. The Active column displays the values currently used by the Prime Optical server.
• Pruning—Defines the Prime Optical database pruning frequency. Database pruning is enabled by default. You can configure the performance monitoring (PM) pruning interval for 5-minute, 10-minute, 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 Prime Optical server.
• Database Operations—Allows you to start a database backup or export from the Control Panel . After entering the password, click Start to begin the database backup or export. The backup section 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.

Complete the following steps to view and modify the database properties:

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

Step 2 Click Database Properties to open the Database Properties pane. Table 4-2 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	Display only . Displays the size of the database server.
Enable ARCHIVELOG Mode	If checked, the ARCHIVELOG mode is enabled. When the database is in ARCHIVELOG mode, Prime Optical supports automatic pruning of the /db05 partition. Note When you check the Enable ARCHIVELOG Mode check box, the Archive Log Pruning Parameters check box (located in the Database Operations tab) is checked automatically. Caution To change the ARCHIVELOG mode in a high availability (HA) configuration, you must freeze the ctmgrp service group before making the change, and unfreeze the ctmgrp service group when the change is complete. Enter the following commands on all of the clusters to freeze the ctmgrp service group: haconf -makerw hagrp -freeze ctmgrp -persistent haconf -dump -makero After the Prime Optical server restarts, enter the following commands on all of the clusters to unfreeze the ctmgrp service group: haconf -makerw hagrp -unfreeze ctmgrp -persistent haconf -dump -makero
Configuration Mode	Configuration Mode tells the Prime Optical server the values to use to log in to the Oracle database. When set to Auto, the Prime Optical server uses the configuration that was set when Prime Optical was installed. When set to Manual, the Password field can be changed, and the Prime Optical server uses the new password after the server is rebooted. Note If you change the configuration mode to Manual, enter the following commands to set the ORACLE_HOME and ORACLE_SID environment variables before logging into Prime Optical again. (The C-shell is assumed for all UNIX commands.) 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 Prime Optical server after setting these environment variables. To do this, enter the opticalctl stop command to shut down the Prime Optical server. Then, enter the opticalctl start command to restart it. Caution If you set the configuration mode to Auto and restart the Prime Optical server, the CTMServer.cfg file does not change; the parameters retain their previous values.
Username	Display only . Displays the username that the Prime Optical server uses to access the Oracle database.
Password	Displays the password that gives the username access to the Oracle database. You can change the database password only if the database is not embedded and if the configuration mode is set to Manual. If the configuration mode is set to Auto, the password is display only. Note The database password cannot contain the characters @, ", and /, because SQL*PLUS interprets them as special characters. Note After a Prime Optical server restart, the Prime Optical client attempts to log in automatically for 6 minutes before exiting. If the Prime Optical server initialization requires additional time to complete, you might need to restart the Prime Optical client. Caution The default password is Ctm123! and any changes are saved in the CTMServer.cfg file. If you change the default password, the following caution is displayed: “Changing the database password will restart the Prime Optical server. Are you sure you want to continue?” Click Yes to confirm the action. The password is validated and the following message is broadcast: “Caution: The database password has been changed by a user. The Prime Optical server will restart in 15 seconds.” Caution To change the Oracle database password in an HA configuration, see “Changing the Oracle Database Password from the Prime Optical Client in an HA Configuration” in Cisco Prime Optical Release 9.6 High Availability Installation Guide.
Confirm Password	(Available when the configuration mode is set to Manual) Re-enter the database password to confirm it.
Location	Display only . Displays the IP address that the Prime Optical server uses to connect to the database.
Port	Display only . Displays the port number that is used to connect to the database.
System ID	Display only . Displays the Oracle system ID. The ORACLE_SID specifies the system identifier (SID) value of the database instance that you create with the Prime Optical 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 Prime Optical installation, the default system ID is CTM.
SQL Network Alias	Display only . 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 (5, 10, 15 min)	Specifies the number of days to save 5-, 10-, or 15-minute PM data before Prime Optical runs the database pruning script. You can save from 1 to 1000 days of data. The default value is 30 days. 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 Prime Optical runs the database pruning script. You can save from 1 to 1000 days of data. The default value is 30 days. 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 cleared and acknowledged alarms in the Alarm Log before Prime Optical prunes alarms from it. You can save from 1 to 1000 days of data. The default value is 7 days. You can also specify the time of day when alarms will be pruned 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 alarm pruning. Note Alarms shown in the Alarm Browser are not pruned. They are saved to the Alarm Log when they are cleared and acknowledged. Alarms can be acknowledged manually by a user, or acknowledged automatically if the automatic acknowledgement feature is enabled in the Control Panel > UI Properties pane > Fault Management area.
Audit Log Data	Specifies the number of days to save Audit Log data before Prime Optical runs the database pruning script. You can save from 1 to 1000 days of data. The default value is 7 days. 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 Prime Optical runs the database pruning script. You can save from 1 to 1000 days of data. The default value is 7 days. 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 Prime Optical runs the database pruning script. You can save from 1 to 1000 days of data. The default value is 7 days. 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 Prime Optical runs the database pruning script. You can save from 1 to 1000 days of data. The default value is 7 days. 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 Prime Optical runs the database pruning script. You can save from 1 to 1000 days of data. The default value is 7 days. 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 > Backup Area
‘sys’ Password	The password for the sys user. The default Oracle password for the sys user is change_on_install .
Backup Status	The status of the database hot backup. The default is Unknown.
Oracle Installation	Check this check box to back up the entire Oracle installation directory.
Operating System Configuration	Check this check box to back up the common operating system configuration files used by the Oracle installation.
Database Configuration	Check this check box to back up the operating system configuration files.
All	Check this check box to back up all of the database components (Oracle installation, operating system configuration, and database configuration).
Start button	Click the Start button to back up the selected database component(s).
Database Operations Tab > Archive Log Pruning Parameters Area
Enable	Allows you to enable (default) or disable archive log pruning. Caution If ARCHIVELOG mode is enabled, the archive log pruning should never be disabled. If the archive log pruning is disabled, the /db05 partition might fill up and the Prime Optical database might shut down.
Threshold	Enter the pruning threshold. By default, when the archive log reaches 70 percent of capacity, pruning begins. Caution Do not set this threshold to a high value (such as 90 percent). If the threshold is too high, the /db05 partition could fill up before the archive log pruning makes space available.
Archive Log Backup Directory	Specify the location for the archive log backup files. The default directory is /ctm_backup. Caution Make sure that the archive log backup directory exists and has enough space to store the compressed archive log files. Check periodically to make sure that this directory is not full.
Database Operations Tab > Export Area
Export Status	The status of the database export process. The default is Unknown.
Oracle Installation	Check this check box to export the entire Oracle installation directory. Caution This option requires a large amount of disk space (about 2.5 GB) in the /ctm_backup directory.
Operating System Configuration	Check this check box to export the common operating system configuration files used by the Oracle installation.
Database Configuration	Check this check box to export the operating system configuration files.
All	Check this check box to export all of the database components (Oracle installation, operating system configuration, and database configuration).
Start button	Click the Start button to export the selected database component(s).

Changing the Prime Optical Database Password

Complete the following procedure to change the password that gives the username access to the Oracle database. You can perform this operation only if the database is not embedded.

The following procedure applies to changing the Oracle database password in a non-HA environment. To change the database password in an HA configuration, see “Changing the Oracle Database Password from the Prime Optical Client in an HA Configuration” in Cisco Prime Optical Release 9.6 High Availability Installation Guide .

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

Step 2 Click Database Properties to open the Database Properties pane.

Step 3 Click the Configuration tab.

Step 4 Change the password in the Password field. The default password is Ctm123! and any changes are saved in the CTMServer.cfg file. You can change the database password if the configuration mode is set to Manual. If the configuration mode is set to Auto, the password is display only.

Note The database password cannot contain the characters @, ", and /, because SQL*PLUS interprets them as special characters.

Step 5 In the Confirm Password field, re-enter the database password to confirm it.

Step 6 After you change the default password, the following caution is displayed: “Changing the database password will restart the Prime Optical server. Are you sure you want to continue?” Click Yes to confirm the action. The password is validated and the following message is broadcast: “Caution: The database password has been changed by a user. The Prime Optical server will restart in 15 seconds.”

Step 7 Click Save .

The Audit Log records the history of the database password change.

• If the Prime Optical server stops, the database password change procedure executes and all Prime Optical clients are shut down.

To check whether the password change succeeded, view the Alarm Browser, which should not indicate a failure with the database password change. The CTMServer.cfg file in the /opt/CiscoTransportManagerServer/cfg directory should report CHANGED in the db-password-change-status section of the file. You can view the file with a system editor or with the command cat CTMServer.cfg .

If the Alarm Browser reports a password-related alarm, view the following report logs in the /temp directory:

– change_db_password_execute.log (the logger file)

– change_db_password_execute.err (the file that contains the error)

– change_db_password.out (the output of the opticalctl stop and opticalctl start scripts)

• If the Prime Optical server does not stop, a prerequisite check failed. View the Alarm Browser for an alarm that explains the failure. Also view the preceding log files to understand the error.

Overview of Backing Up the Prime Optical Database

This section provides guidelines for backing up the Prime Optical database. Various factors affect the database backup, including the type of installation and the Prime Optical system performance. Ultimately, your database administrator (DBA) must determine the best method of backing up the Prime Optical database.

Consider the following definitions:

• Backing up the database means safely storing the data in the Prime Optical database.
• Restoring the database means taking a specific image of a previous database backup and applying it to re-establish an earlier situation.
• Recovering the database means taking a specific image of a previous database backup and applying it to recover from data corruption or loss of data.

You can back up the Prime Optical database using the following methods, which are described in Table 4-2 and in the subsequent sections:

• Hot backup
• Cold backup
• Export

Understanding Hot Backup, ARCHIVELOG Mode, and the /db05 Directory

You can perform a hot backup while the Prime Optical server is running. A hot backup requires no downtime, but your Prime Optical database must be running in ARCHIVELOG mode.

In ARCHIVELOG mode, the database saves a redo log whenever a log switch occurs in /db05/*.arc files. Redo logs are composed of a group of special files that are filled cyclically. Before rewriting an existing redo log, the archive process makes a copy of the log and produces the archive (.arc) files.

Oracle registers in the redo logs every activity that occurs in the database.

It is not possible to estimate the rate of production of archive files, because the rate depends on the number of log switches in the system. The number of log switches relates to the Prime Optical server workload: During an intensive session with multiple commits of active transactions, the number of log switches increases.

The archive files, in addition to the initial backup of the database, are part of the backup itself and must be kept in a safe place, such as on tape or on a similar storage device. Prime Optical uses the /db05 partition to store the archive files.

During normal system operation, the /db05 directory fills up. You can configure automatic pruning of the /db05 directory in the Control Panel . If automatic pruning is enabled, the archive files are zipped and moved to the /ctm_backup directory.

Prime Optical checks the /db05 partition once every 5 minutes. When archive log pruning for the /db05 partition exceeds the configured threshold, all archive files except for the most recent one are compressed and moved to the /ctm_backup directory. Therefore, make sure that /db05 is in its own partition and not under the root directory.

Set the archive log pruning threshold to a medium value, such as 60 or 70 percent. If you set the threshold to a very high value (such as 90 percent), you risk filling up the /db05 partition. If the /db05 partition fills while ARCHIVELOG mode is enabled, Oracle stops and Prime Optical hangs.

If you set the threshold to a very low value (such as 10 percent), the /db05 partition is pruned continuously, which slows down the system unnecessarily.

To view or change the archive log pruning threshold:

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

Step 2 Click Database Properties to open the Database Properties pane.

Step 3 Click the Database Operations tab. The Archive Log Pruning Parameters area shows the configured threshold.

Step 4 After modifying the Threshold value, click Save .

A database backup comprises two main groups of files:

• The files produced under the /ctm_backup directory, which contains a compressed dump of all of the data in the database, including the actual read logs.
• The archive (.arc) files produced during and after the backup.

You can perform a hot backup from the GUI (see Backing Up the Prime Optical Database from the Prime Optical GUI). You can also perform a hot backup from the CLI, using the backupdb.sh script (see Backing Up or Exporting the Prime Optical Database from the CLI).

The Prime Optical restore procedure manages all of the information required to restore the database; you provide only the location of the backup and archive files.

A hot backup has the following advantages:

• You can recover the database contents up to the last transaction that occurred before a crash, returning the lowest amount of lost data.
• There is no Oracle downtime.
• You can use Oracle’s RMAN product to configure the backup.

A hot backup has the following disadvantages:

• It requires more disk space, because depending on database activity, the archive log function produces many snapshots.
• It requires planning to avoid filling up the archive log and the /db05 partition.

Use the following guidelines for performing a hot backup:

• By default, the files created by the hot backup are saved in the /ctm_backup directory. Make sure that the /ctm_backup directory exists and has the correct permissions and adequate space.
• Make sure that /ctm_backup is not under the root partition, because it could fill up.
• For optimal results, the Prime Optical server should perform limited activity on the database while the hot backup is running. Therefore, launch the hot backup when users are not working on the system.
• All of the changes performed by the Prime Optical server after the backup starts are logged to the archive files under /db05. These archive files contain required copies of redo logs that are overwritten by Oracle along with the backup files under /ctm_backup.
• Perform a hot backup regularly, especially after completing a significant amount of work. Regular backups reduce the number of archive files to save.
• In a stable network, it is recommended that you perform both a hot backup and a full export. Before the first backup, remove all nonessential files from the /ctm_backup and /db05 directories.
• After a hot backup, save all files in the /db05 and /ctm_backup directories in a safe place.

Use the following guidelines for restoring the database:

• After using a hot backup to restore or recover the database, all previous backups become obsolete. It is recommended that you perform a hot backup after a restore, when all previous backups can be safely removed.
• Restore the database on the same workstation where the backup was performed. This is particularly important in high availability configurations.

Use the following guidelines for managing the archive log:

• It is important to store safely the archive files that are produced after a hot backup.
• To avoid generating many archive files that must be saved on disk or tape, perform a hot backup on a regular basis. Regular backups facilitate the restore/recovery operation by reducing the number of archive files to save.

Monitoring the Growth of the /ctm_backup Directory

Because it is not possible to estimate the rate of production of archive files, the /ctm_backup directory might exhaust the available disk space. Without disk space, the Oracle archive process cannot archive the redo logs to be overwritten, and the database freezes. The archive redo logs, which are vital to restore and recover a database, must be saved in a safe place. You might want to create a cron job to save your data.

Understanding Cold Backup

A cold backup is the safest way to take a snapshot of the database. In a cold backup, the Prime Optical server is stopped; then, the Oracle database is shut down. The database contents and the directories /db01, /db02, /db03, /db04, and /db05 are copied to a tape or storage device.

A cold backup has the following advantages:

• Thorough, safe physical backup of the database.
• Simple to complete using basic operating system (OS) commands and by copying all of the files and the directory structure of /db01, /db02, /db03, /db04, and /db05.

A cold backup has the following disadvantages:

• Because you take a physical copy of the entire database at a specific time while Prime Optical and Oracle are down, the database image is not updated with subsequent modifications.
• A cold backup requires you to shut down Prime Optical, during which time network monitoring is unavailable.

There is no recommended procedure to perform a cold backup; instead, your database administrator determines the exact steps. Use the following guidelines:

• Take a cold backup before any activities that could cause problems with Prime Optical or your OS (for example, before installing an Oracle patch or upgrading your Prime Optical version).
• Take a cold backup after important changes.
• Create a .tar file of all of the structures in $ORACLE_HOME and include it with the cold backup files.

Understanding Export

An export is a logical copy of the database objects on a single *.dmp file. You can export the database from the GUI (see Exporting the Prime Optical Database from the Prime Optical GUI). You can also export the database from the CLI, using the export_full_db.sh script (see Backing Up or Exporting the Prime Optical Database from the CLI).

When exporting the database, all of the constraints are removed; then, the objects and constraints are recreated. It is recommended that the Prime Optical server be shut down during the export operation.

An export has the following advantages:

• It is relatively easy to take a logical snapshot of the database contents at a specific time.
• There is no Oracle downtime.
• The restore operation is simple and can be applied on different servers (with the correct database schema).

An export has the following disadvantages:

• It is not a complete backup. If you have database corruption that you cannot recover from, you must recreate the database and then repopulate it with a full export.
• To avoid inconsistencies, you must stop the Prime Optical server.

Use the following general guidelines when exporting the database:

• An export is useful to re-establish the previous contents of the database. Use an export when you plan a critical modification or to eliminate fragmentation.

For example, export the database before migrating from a single-server Prime Optical configuration (where the Prime Optical server and database are on the same workstation) to a dual-server Prime Optical configuration (where the Prime Optical server and database are on separate workstations).

• If you want to restore a database backup that was exported before you migrated to a later Prime Optical version, you must reinstall the earlier Prime Optical version in order to maintain the earlier Prime Optical database schema. Whenever you restore a database, you must restore it on the same Prime Optical version from which it was created. Otherwise, the restored data does not match the current database schema and Oracle cannot interpret the data.
• Export the database only after the Prime Optical server is stable; for example, after the first network discovery is complete. Doing so ensure that you have an accurate snapshot of your entire network configuration.

Backing Up the Prime Optical Database from the Prime Optical 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.

Prime Optical 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 In the Backup area, enter the sys password in the ‘sys’ Password field.

Step 5 (Optional) To back up additional database components, check any of the following check boxes in the Backup area:

• Oracle Installation—Backs up the entire Oracle installation directory.
• Operating System Configuration—Backs up the common operating system configuration files used by the Oracle installation.
• Database Configuration—Backs up the operating system configuration files.
• All—Backs up all of the database components.

Note If you do not check any of the preceding check boxes, only the Prime Optical database is backed up.

Step 6 In the Backup area, click Start .

The backup log file is saved to /oracle/admin/ ORACLE-SID /udump/backup_db.log. The log file contains all of the files that have been backed up.

Note If the backup is interrupted, you cannot start a new backup from a Prime Optical client; you must use the CLI. Launch the script /setDbBackupStatus.sh from the server as root where the database is installed, at the following location:

cd/opt/CiscoTransportManagerServer/bin

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.

Exporting the Prime Optical Database from the Prime Optical GUI

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 Check any of the following check boxes in the Export area:

• Oracle Installation—Exports the entire Oracle installation directory.
• Operating System Configuration—Exports the common operating system configuration files used by the Oracle installation.
• Database Configuration—Exports the operating system configuration files.
• All—Exports all of the database components.

Note If you do not check any of the preceding check boxes, only the Prime Optical database is exported.

Step 5 In the Export area, click Start .

The file is exported to the /ctm_backup/export_dir directory using the filename export_CTM time-stamp .dmp. The log file is named export_CTM.log.

Backing Up or Exporting the Prime Optical Database from the CLI

Prime Optical uses the /ctm_backup directory as the default backup directory.

Step 1 To perform a logical database backup (export) from the 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.

Performing an export_full_db operation from the CLI requires you to shut down the Prime Optical server.

The file is exported to the /ctm_backup/export_dir directory using the filename export_CTM time-stamp .dmp. The log file is named export_CTM.log.

Step 2 To export the database and back up selected components, enter any of the following commands as the root user:

• export_full_db.sh ORA_INST —Exports the database and backs up the entire Oracle installation.
• export_full_db.sh ORA_CFG_FILE —Exports the database and backs up the configuration files, including init.ora, tnsnames.ora, listener.ora, and sqlnet.ora.
• export_full_db.sh OS_CFG_FILE —Exports the database and backs up the OS configuration files, including /etc/passwd, /etc/group, /etc/system, and /var/opt/oracle/oratab.
• export_full_db.sh ALL —Exports the database and backs up all of the preceding configuration files.

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

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

The backup is stored under /ctm_backup folder. The backup log file is saved under /temp_CTM/backupdb.log.

Step 4 To back up selected components, enter any of the following commands as the root user:

• backupdb.sh ORA_INST —Backs up the entire Oracle installation.
• backupdb.sh ORA_CFG_FILE —Backs up the configuration files, including init.ora, tnsnames.ora, listener.ora, and sqlnet.ora.
• backupdb.sh OS_CFG_FILE —Backs up the OS configuration files, including /etc/passwd, /etc/group, /etc/system, and /var/opt/oracle/oratab.
• backupdb.sh ALL —Backs up the database and all of the preceding configuration files.

Restoring the Prime Optical Database from the Previous Backup

Complete the following steps to restore the Prime Optical 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 Disconnect all of the Prime Optical clients and enter the following command to shut down the Prime Optical server, if it is running:

Step 2 To restore the database from a hot backup, log in to the Prime Optical database workstation as the root user and enter the following commands:

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

Step 3 Enter the following command to manually restart the Prime Optical server:

Note The Prime Optical server does not restart automatically after restoring the database.

Step 4 To restore from an export dump file, enter the following commands to import the database:

The default location of the configuration file is /ctm_backup/export_conf.cfg.

Pruning the Prime Optical Database

Database pruning is critical to Oracle server performance. If the Prime Optical database files grow too large, it creates extra work for Oracle to insert or remove records from the middle of the database. This section describes how to set the time and date for automatic database pruning and how to use pruning scripts.

Setting the Time and Date for Automatic Pruning

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

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

Step 2 Click Database Properties to open the Database Properties pane.

Step 3 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.

Consider scheduling database pruning for the middle of the night, when Prime Optical is least busy. It is helpful to schedule each pruning activity to start separately, with some time between each pruning script. For example, you might start pruning at midnight and allow 30 to 45 minutes for each pruning activity before starting the next one.

Note that the start time for pruning activities is set according to Greenwich Mean Time (GMT), not local time.

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

Using Pruning Scripts

Aside from automatic pruning, you can also prune Prime Optical 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

Complete the following steps to prune Prime Optical data using pruning scripts:

Step 1 Log in as the root user on the host where the Prime Optical server is installed.

Step 2 Enter the following command to change directories to the Prime Optical server bin directory:

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

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 table lists 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-4 lists 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,” Prime Optical prunes 15-minute data, 1-day data, or both 15-minute and 1-day data. If the “Is 24 flag” value is blank, Prime Optical prunes both 15-minute and 1-day data.

Table 4-5 lists 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.

Using the SQL*PLUS Client to Manage the Database

To access the database and Prime Optical 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 Linux 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 Linux 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 Prime Optical user and managing Prime Optical schema objects and data. Refer to Oracle’s SQL*PLUS User’s Guide and Reference for a complete description.

Step 1 On the Linux workstation running Oracle, log in as the Oracle owner user. Use the username that was used when installing Oracle 10g.

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:

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

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

Understanding Basic SQL Commands for Prime Optical Schema Objects

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

Using the Prime Optical Interactive Database (DB) Console to Manage the Database

To access the database and Prime Optical schema objects, use the Prime Optical Interactive Database (DB) Console. The DBconsole is used when the server is installed with an embedded database.

Get the Prime Optical Interactive Database Console from the Prime Optical Client folder at the location <Prime Optical client installation directory>\DB_Console.

Executing the Prime Optical Interactive Database Console

The Prime Optical Interactive DB Console tool is a Java application that you execute by running runme.bat (Windows) or runme.sh (Linux). JRE 1.6 or higher is required to execute DB Console. Go to the Java website to obtain the latest version of Java Runtime Environment for your operating system.

Connecting to the Database

Complete the following steps to connect to the database:

Step 1 Choose Session > Connect .

Step 2 In the Hostname field, enter the hostname of the server or the IP address.

Step 3 Click Connect .

Note You must connect to the database through a special database user login. Using this login, you will only be able to view tables and other objects in the embedded database. You will not have read/write access.

Managing the Database Using the Prime Optical Interactive Database Console

Interactive Database Console is a command-line interface (CLI) that allows you to browse the database tables.

To get a list of allowed commands, execute the following command in the CLI:

To get the detailed synopsis and description of a specific command, execute the following command in the CLI:

The following example shows output for the import command:

Table 4-7 lists the aliases that already exist to enable you to check the status of the Prime Optical database:

The Database Interactive Console supports automatic command completion (Tab key), and command history (up/down arrow). To clear command history, choose Edit > Clear History .

Launching Batch Scripts

To launch automatic scripts, choose File > Load Script .

A batch script can contain any number of allowed commands. DB_Console includes an example script named report.txt that collects information on the status of the Prime Optical database.

Setting Preferences for the Prime Optical Interactive Database Console

Complete the following steps to set the preferences for the Interactive Database Console:

Step 1 Choose Edit > Preferences.

Step 2 In the General tab, set preference for the following:

• Default Hostname or IP Address
• Database Schema ID (SID)
• Screen Buffer Size

Step 3 In the Font and Color tab, set preferences for the following:

• Font color
• Background color
• Foreground color

Step 4 Click Apply . For some changes (for example, default host or screen buffer) to take effect, you must restart the application.

Regenerating Statistics in the Database

Internal Oracle statistics allow Oracle to work efficiently, especially during data query operations. If there is Prime Optical system performance degradation during normal database activities, the database might be using stale statistics. The database statistics should be regenerated to improve system performance, either before or after a significant system workload.

In Oracle 10g, the statistics are automatically regenerated every night. The Prime Optical installation uses the default settings of Oracle 10g. If you need to change the statistics regeneration schedule, refer to the official Oracle 10g documentation for instructions on how to change the settings.

Cleaning Up the Disk and Maintaining Disk Space on the Prime Optical Server

It is important to clean up the disk and maintain disk space on the Prime Optical server. To maintain an efficient server and maximize performance, you must delete unnecessary files and retain only the minimum number of files. For detailed information, see Clean Up the Disk and Maintain Disk Space on the CTM Server .

Transferring Images

You can transfer NE binary software images from the client file system into an appropriate NE software repository in the Prime Optical 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 EDFA
• ONS 15216 EDFA2
• ONS 15216 EDFA3
• ONS 15305 (including the CTC-based ONS 15305 R3.0)
• ONS 15310 CL
• ONS 15310 MA SONET
• ONS 15310 MA SDH
• ONS 15327
• ONS 15454 SONET
• ONS 15454 SDH
• ONS 15600 SONET
• ONS 15600 SDH

To transfer images into an appropriate NE software repository:

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.

Step 3 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 4 To remove a file from the Local File Selection list, select the file from the list and click Delete .

Step 5 Choose the NE-specific folder from the Prime Optical server drop-down list to indicate where to transfer the image.

Step 6 To remove a file that is already present on the Prime Optical server, choose the file from the list and click Delete .

Step 7 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.

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 15305 (not supported for the ONS 15305 R3.0)
• ONS 15310 CL
• ONS 15310 MA SONET
• ONS 15310 MA SDH
• ONS 15327
• ONS 15454 SONET
• ONS 15454 SDH
• ONS 15600 SONET
• ONS 15600 SDH

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

Usage Notes:

• Refer to the appropriate NE documentation for precautions and guidelines before performing an NE software upgrade.
• Before updating the software image on an NE, check the Prime Optical release notes to verify whether the NE software release is supported by Prime Optical. See the “Prime Optical-Supported NE Software Releases” table in the Cisco Prime Optical Release Notes .
• If a software download has a status of Queued, and if it has a task in the running list, the download cannot be canceled.
• 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.
• To download software images to NEs, it is recommended that the data communications network (DCN) bandwidth be 56 kb/s or higher. If DCN bandwidth is less than 56 kb/s, 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-kb/s 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.
• 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.

Downloading Software Images to ONS 15216, ONS 153xx, ONS 15454, and ONS 15600 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 . The Software Management wizard opens. Table 4-8 provides descriptions.

Step 3 Enter the following information:

• NE model
• NEs
• Source
• Job comments
• Time

Step 4 Click Finish to initiate the software download to the standby memory on the NE.

Step 5 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.

Step 6 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.

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

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

Prime Optical stores two software versions: active and standby. When you download software, it is saved as the standby version.

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 > 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 Prime Optical Server area. Choose Cisco ONS 15216 EDFA3 from the drop-down list; then, click Upload. Then, choose Administration > Software Management > Optical. The Software Management wizard opens with the Server radio button enabled.

Scheduling Bulk Software Activation

Use the Bulk Software Activation dialog box to schedule software activation for multiple NEs simultaneously. Bulk software activation is supported on NEs that support the Revert/Switch operation: ONS 15216 EDFA2, ONS 15216 EDFA3, ONS 15305, ONS 15310 CL, ONS 15310 MA SONET, ONS 15310 MA SDH, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, ONS 15600 SDH.

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 one or more NEs that are assigned an In Service or Under Maintenance state.

Step 2 Choose Administration > Bulk Software Activation . The Bulk Software Activation dialog box opens. The following table provides descriptions.

Note You can also launch the dialog box by selecting one or more rows in the NE Software table and choosing Edit > Commit.

Step 3 In the dialog box, select the NEs for which you want to activate software, enter any comments about the job, and specify the time for the software activation to occur.

Step 4 Click OK .

To view the results of the bulk software activation, check the Job Monitor table ( Administration > Job Monitor ).

Topology Network has Gateway Network Element (GNE) and External Network Element (ENE). Sometimes, it is not possible to send bulk software activation update GNE and ENE to prime optical that reflects a failure status in the Job Monitor table. Prime Optical sends activation/revert command to CTC which sends a failure status indication to prime optical that takes the exceptions and manages. Changes in active NE is updated from failure to success status in Job Monitor Table.

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 Active NEs failure status is monitored. It is not possible for the ENEs to send the failure report to GNEs, when the GNEs are down. This event is not updated in the prime optical server. This event is not updated in the prime optical server. Prime Optical sends activation/revert command to CTC which sends a failure status indication to prime optical that takes the exceptions and manages. Changes in active NE is updated from failure to success status in Job Monitor Table.

Step 1 In the Domain Explorer tree, select an NE and choose Administration > NE Software Table . Table 4-10 provides descriptions.

• For NEs other than the ONS 15216 EDFA, the NE Software table displays the active and standby software versions for the NE.
• For ONS 15216 EDFA 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 (or click the NE Software Table tool).

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

For the ONS 15305 (non-CTC-based) and 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.

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 choose Edit > Revert/Switch (or click the Revert/Switch tool). At the confirmation prompt, click OK .

• For the ONS 15216 EDFA, ONS 15310 CL, ONS 15310 MA SONET, ONS 15310 MA SDH, 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 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.

Step 4 To accept the software version of an NE, select the NE and choose Edit > Accept (or click the Accept tool). 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.

Activating a New NE Software Version on One or More ML-Series Cards

When an ONS 15310 CL, ONS 15454 SONET, or ONS 15454 SDH NE is partially upgraded to a new software version, you can choose to activate the new NE software version on one or more ML-series cards.

Note If the Partial Upgrade field in the NE Software Table is set to False, it means that the NE and all its cards are upgraded to the new NE software version. If set to True, it means that one or more cards are still running an older software version.

Step 1 In the Domain Explorer , select a group or an ONS 15310 CL, ONS 15454 SONET, or ONS 15454 SDH NE that contains ML-series cards, and choose Administration > NE Software Table .

Step 2 In the NE Software Table, select one or more NEs that are in Partial Upgrade mode and choose Edit > Reset ML Cards (or click the Reset specific ML Cards tool).

Step 3 In the Reset ML Cards dialog box, select the ML-series cards on which to activate the new software. Use the Add button to move the ML-series cards to the Selected list. Use the Remove button to move the ML-series cards to the Available list.

Step 4 Click OK.

Delaying Software Activation on the ML-Series Cards

You can delay software activation on an ONS 15310 CL, ONS 15310 MA SONET, ONS 15310 MA SDH, ONS 15454 SONET, or ONS 15454 SDH NEs ML-series cards when the NE is partially upgraded to a new software version and the NODE.software.AllowDelayedUpgrades parameter is set to TRUE.

Note You can change the value of the NODE.software.AllowDelayedUpgrades parameter in the NE Defaults tab of the NE Explorer.

Step 1 In the Domain Explorer , select a group or an ONS 15310 CL, ONS 15310 MA SONET, ONS 15310 MA SDH, ONS 15454 SONET, or ONS 15454 SDH NE that contains ML-series cards, and choose Administration > NE Software Table .

Step 2 In the NE Software table, select an NE that is in Partial Upgrade mode and choose Edit > Commit (or click the Commit tool). The Bulk Software Activation wizard opens.

Step 3 Do the following:

a. Select the NE for which you want to activate software

b. Enter any comments about the job.

c. Specify the time for the software activation to occur.

Step 4 Click OK . The Software Activation dialog box opens.

Step 5 Check the Delay automatic activation on the ML cards check box to delay software activation. Uncheck the check box if you do not want to delay software activation.

Note The Delay automatic activation on ML cards check box is checked by default if the NODE.software.DefaultDelayedUpgrades parameter is set to TRUE.

Step 6 Click OK in the Software Activation dialog box.

Step 7 Click OK in the Confirm commit message box.

Step 8 Click OK in the Prime Optical Progress message box.

Adding a New NE Software Version to the Prime Optical 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, Prime Optical-supported software on the supported NE. Major upgrades to NE software might require you to update Prime Optical.

Complete the following steps to add a new NE software version to the Prime Optical domain:

Step 1 In the Domain Explorer window, choose Administration > Supported NE Table . Table 4-11 provides descriptions.

Step 2 Select an NE.

Step 3 Choose Edit > Add (or click the Add Device Maintenance Version tool).

The Add Device Maintenance Version dialog box opens.

Step 4 From the NE Model drop-down list, choose the NE model.

Step 5 In the Software Version field, enter the software version.

Step 6 Click Submit .

Note You cannot customize the Version Name field. Prime Optical retrieves the version name from the Version Name field of the base version.

A message appears, displaying the version name.

Step 7 Click OK .

The new NE is added and the newly added NE displays an icon in the Software Version column.

Deleting an NE Software Version from the Prime Optical 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.

Changing IP Addresses for NEs

Prime Optical displays the active IP address of the selected NE. The active IP address field for end NEs (ENEs) is the IP address of the gateway NE (GNE) that the NE is using. This information is calculated on a theoretical projection, which does not necessarily equate to a real network situation.

Changing the NE IP Address on CTC-Based NEs

Step 1 In the Domain Explorer window, click the NE and choose Configuration > NE Explorer (or click the Open NE Explorer tool).

Step 2 In the property sheet of the NE Explorer , click the Network tab > Address tab.

Step 3 Change the IP address in the IP Address field. (For an IPv6 node, change the address in the IPv6 Config > IPv6 Address field.)

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 4 If necessary, change the following fields:

• Default Router (for an IPv4 node)
• Subnet Mask (for an IPv4 node)
• IPv6 Config > Default IPv6 Router (for an IPv6 node)
• IPv6 Config > IPv6 Subnet Mask (for an IPv6 node)

Step 5 Click Apply.

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

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 ENE node first; then, change the IP address on the GNE node. You do not need to remove NEs from Prime Optical.

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 Prime Optical:

Step 1 Remove the ENE settings on the ENE. In the Network Explorer, click the Network tab > Firewall/Proxy tab; 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 tab. 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 tab; then, uncheck the Enable Proxy Server on Port check box.

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

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

Switching Connectivity from IPv4 to IPv6

Prime Optical provides IPv6 support for the following NE releases: ONS 15310 MA SDH R9.3, ONS 15310 MA SONET R9.3, ONS 15454 SDH R9.3, and ONS 15454 SONET R9.3.

Note IPv6 loopback address must be configured on the server in order for Prime Optical to work with IPv6.

Prime Optical tries to connect to an NE using its preferred IP address: IPv4 or IPv6, depending on how the NE was added or discovered by Prime Optical.

• For a user-added NE, the preferred IP address is the one that was entered when the NE was added.
• For a discovered NE, the preferred IP address depends on the IP connectivity of the GNE that discovered it.

If the preferred IP address is not reachable, Prime Optical tries to connect to the NE with the other IP address.

To enable IPv6 on an NE that supports this feature, complete the following steps:

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

Step 2 In the property sheet of the NE Explorer , click the Network tab > Address tab.

Step 3 In the IPv6 Config area, check the Enable IPv6 check box and configure the following fields:

• IPv6 Address
• Default IPv6 Router
• IPv6 Subnet Mask

Step 4 Click Apply .

Note If the IPv4 address is unavailable or disabled on the NE, Prime Optical uses the IPv6 address. If the NE is reachable through its IPv4 address, Prime Optical uses that address.

Changing the NE IP Address in Prime Optical Only

Note If the IP address is changed in Prime Optical, the change is made only in Prime Optical.

Complete the following steps to change the IP address in Prime Optical only:

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.

Step 3 Click Save .

Changing the Internal Subnet Address—ONS 15600 SONET and ONS 15600 SDH

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.

Complete the following steps to change the internal subnet address:

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 , click the Network tab > Internal Subnet tab.

Step 4 Specify the following values 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 5 Click Apply .

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 , click the Network tab > Address tab.

Step 3 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— Display 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 4 In the node properties pane of the NE Explorer , click the Security tab > Access tab.

Step 5 In the CORBA (IIOP) Listener Port field, select one of the following values to allow communication with the NE through firewalls:

• Default-Fixed
• Standard Constant (683)
• Other Constant

Step 6 Click Apply .

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 GNEs, ENEs, or tunnel NEs (TNEs). The GNE is LAN-connected to the DCN, while the ENE is accessed through the proxy server feature on the GNE over the 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. Prime Optical connects to TNEs that belong to an OSI network behind a non-Cisco GNE. Also, if an NE is LAN-connected and its proxy is disabled, the NE is shown as a LAN-connected NE (LNE).

Enabling Proxy

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 Properties pane of the NE Explorer , select the Network tab > Firewall/Proxy tab.

Step 3 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 default value of 1080.

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

• ENE
• GNE
• Proxy-only

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

Step 5 Click Apply .

Notes on Configuring Proxy Server Settings

Note the following when configuring proxy server settings:

• In a proxy environment, you can launch CTC from Prime Optical 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 as Out of Service or is not reachable from Prime Optical. Launching CTC for NEs that are not reachable before Prime Optical can determine whether they are reachable 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.
• Prime Optical can configure multiple GNEs but it can only associate a single GNE for a given ENE. If the GNE becomes inaccessible, Prime Optical can automatically use one of the other available GNEs to reach the ENE.
• When a proxy-enabled GNE (named GNE1) is first added to Prime Optical, Prime Optical 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, Prime Optical will mark them as GNEs. 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 as Out of Service, then marked as In Service again.
• If both LAN and DCC connections exist between the GNE and ENEs, the DCC connection takes precedence.

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

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

• GNE with SNMPv1, v2, and v3.

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

• ENE with SNMPv1, v2, and v3.

Note Prime Optical 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-12 . For NE release 5.0 and later, see Table 4-13 . In order for Prime Optical 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.

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

Conditions Under Which Prime Optical Recognizes an NE as an LNE, a GNE, a TNE, or an ENE

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

NE terminology:

• 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 the NE Explorer > Network > Firewall/Proxy tab).
• Firewall Enabled denotes whether the “Enable Firewall” option is checked for the NE (in the NE Explorer > Network > Firewall/Proxy tab).
• Craft Access Enabled denotes whether the “Craft-Access Only” option is checked for the NE (in the NE Explorer > Network > Firewall/Proxy tab).
• GNE denotes whether the “Gateway Network Element (GNE)” option is selected for the NE (in the NE Explorer > Network > Firewall/Proxy tab).
• ENE denotes whether the “External Network Element (ENE)” option is selected for the NE (in the NE Explorer > Network > Firewall/Proxy tab).
• Proxy-only denotes whether the “Proxy-only” option is selected for the NE (in the NE Explorer > Network > Firewall/Proxy tab).
• A value of N/A indicates that the setting for that column is irrelevant to the end result.

Prime Optical terminology:

• Prime Optical GNE —Gateway network element. A GNE is an NE that is LAN-connected and provides access to and proxies for other NEs that are otherwise unreachable.
• Prime Optical ENE —External network element. An ENE is an NE that is not directly reachable. These NEs can only be accessed via (proxied by) a GNE.
• Prime Optical LNE —LAN-connected NE. An LNE is connected on the LAN and does not proxy for and is not proxied by other NEs.
• Prime Optical TNE —Tunnel NE. Prime Optical can connect to a TNE that belongs to an OSI network behind a non-Cisco GNE. You can open a new TL1 tunnel on a selected TNE, close an existing TL1 tunnel, or modify the TL1 tunnel settings. TNEs do not support SNMP. The following NE models support TL1 tunnels: ONS 15310 CL, ONS 15310 MA SONET, ONS 15310 MA SDH, ONS 15327, ONS 15454 SONET, and ONS 15454 SDH.

Note the following configuration restrictions:

• For all cases where the NE type is denoted as ENE, per current Prime Optical design, an ENE will not have connectivity in Prime Optical unless there is at least one GNE in the same ring as the ENE.
• All NEs on the same Ethernet segment must have the same value for craft access. Mixed values might leave some nodes unreachable through the shared Ethernet segment.
• All NEs on the same Ethernet segment must have the same value for the firewall. Mixed values might leave some nodes unreachable.
• All NEs in the same SDCC area must have the same value for the firewall. Mixed values might leave some nodes unreachable.
• If the firewall is enabled on an NE, the proxy server must also be enabled. If the proxy server is not enabled, CTC cannot see nodes on the DCC side of the NE.
• If Craft Access Only is enabled on an NE, the proxy server must also be enabled. If the proxy server is not enabled, CTC cannot see nodes on the DCC side of the NE.
• Only those NEs that have no LAN connectivity to the Prime Optical server can have Craft Access Only enabled or be set as an ENE.

Creating a New Proxy Tunnel

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, click the Network tab.

Step 3 Click the Proxy Tunnels tab.

Step 4 Click Create . The Create New Proxy Tunnel dialog box opens. The following table provides descriptions.

Step 5 After making your selections, click OK .

Creating a New Firewall Tunnel

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, click the Network tab.

Step 3 Click the Firewall Tunnels tab.

Step 4 Click Create . The Create New Firewall Tunnel dialog box opens. The following table provides descriptions.

Step 5 After making your selections, click OK .

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 > Status tab > Operational State field, choose one of the following values:

• Preprovisioned—(Not available if already provisioned) The NE has been added to the database for provisioning but is not yet in service. Prime Optical does not manage preprovisioned NEs.
• In Service—The NE is deployed and requires monitoring. Prime Optical 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 Prime Optical 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 Prime Optical 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 Prime Optical based on the initialization tasks that are completed:

• In Service–Initializing—The NE is marked as In Service–Initializing when Prime Optical 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 Prime Optical 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 Prime Optical alarm time stamp in the Alarm Browser window is resynchronized with the time stamp when the NE is put back in service.

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

Step 1 In the Domain Explorer , select an NE and choose Configuration > NE Explorer (or click the Open NE Explorer tool).

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

Step 3 In the Location area:

• Set the latitude of the NE by choosing 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 choosing 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, choose the time zone where the NE is located.
• Use Daylight Savings Time—When checked, Daylight Savings Time is observed.

Step 5 Click Apply .

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.

Note SNTP is not supported on the CTC-based ONS 15305 R3.0.

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

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

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

• Set up the SNTP server and optional backup SNTP server, to set the date and time of the node:

– Check the Use NTP/SNTP Server check box.

– In the SNTP Server field, enter the SNTP server’s IP address.

– (Optional) In the Backup SNTP Server field, enter the backup 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 .

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. You can provision primary and secondary NTP and SNTP server addresses. Both the primary and secondary NTP/SNTP address can have IPv4 or IPv6 format.

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, Prime Optical 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 NEs.

Step 1 In the Domain Explorer , choose Administration > SNTP Configuration . The SNTP Configuration dialog box opens. Table 4-20 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.

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 provides descriptions.

Step 3 After making your selections, click Save .

Backing Up NE Memory

Prime Optical allows you to back up 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 only that NE.

Prime Optical backs up configuration and provisioning information residing in the flash memory of an NE. Prime Optical 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 Prime Optical 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 enter 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. Prime Optical 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 SONET
• ONS 15310 MA SDH
• ONS 15327
• ONS 15454 SONET
• ONS 15454 SDH
• ONS 15600 SONET
• ONS 15600 SDH
• CPT 200
• CPT 200 SDH
• CPT 600
• CPT 600 SDH

Usage Notes:

• 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.
• Prime Optical does not support memory backup for the ONS 15305 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 Prime Optical server automatically backs up memory for NEs once a day for seven days and stores the backup files on the Prime Optical 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-22 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 Building the Network for information about configuring 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 15600 NEs, proceed to Step 6.
• For ONS 15216, ONS 15310 CL, ONS 15310 MA SONET, ONS 15310 MA SDH, ONS 15327, ONS 15454 SONET, or ONS 15454 SDH NEs, click Finish to initiate the memory backup procedure.
• 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, ONS 15310 MA SONET, or ONS 15310 MA SDH, 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

Step 5 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-22 for details):

• Provisioning data (is selected by default and is display 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

Restoring NE 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 CL
• ONS 15310 MA SONET
• ONS 15310 MA SDH
• ONS 15327
• ONS 15454 SONET
• ONS 15454 SDH
• ONS 15600 SONET
• ONS 15600 SDH

Usage Notes:

• 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.
• Prime Optical does not support memory restore for the ONS 15305 or Not Managed/Other Vendor NEs.

Complete the following steps to restore NE memory:

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. You cannot restore memory for preprovisioned or out-of-service NEs.

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

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

• NE model
• NEs (select only one)
• Source
• Job comments
• Memory restore options (available only for CTC-based NEs)
• Time

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

• For the ONS 15310 CL, ONS 15310 MA SONET, ONS 15310 MA SDH, ONS 15327, ONS 15454 SONET, or ONS 15454 SDH, proceed to Step 5.
• For the ONS 15600 SONET or ONS 15600 SDH, proceed to Step 7.
• For the ONS 15216 EDFA2 or ONS 15216 EDFA3 NEs, click Finish .

Step 5 For the ONS 15310 CL, ONS 15310 MA SONET, ONS 15310 MA SDH, 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

Prime Optical 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.

Step 6 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-24 for details):

• Provisioning data (is selected by default and is display 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 ( Administration > Job Monitor ). For information about the Job Monitor table, see Monitoring Scheduled Tasks.

Viewing and Modifying NE Service Properties

The NE Service pane in the Control Panel window allows you to view and update Prime Optical server configuration information, which includes 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. The NE Service pane contains the following tabs, which are described in Table 4-25 :

• NE Poller—Allows you to change timing parameters and CTC IIOP port information.
• NE Auto Backup—Allows you to configure automatic NE backup parameters.
• NE Manual Backup—Allows you to configure manual NE backup parameters.

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 Prime Optical is limited to running a maximum number of 23 Java processes. Enter the opticalctl status command to view the current number of running processes.

Understanding the Unmanaged NE Service

Unmanaged NEs have their own NE service. This Unmanaged NE Service allows Prime Optical 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

The Unmanaged NE Service also supports DWDM topology with IP Address along with the optical configuration. The following features are supported:

• Assign the type of the NE (CRS-1, CRS-3) and the IP address.
• Ability to cross-launch Prime Network from the unmanaged device.
• Create manual links between ONS and unmanaged NEs.
• Create patchcords that connects any CRS port to the ROADM device.

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

Changing Timing Parameters

Use the NE Service pane to tune timing parameters and accommodate different Prime Optical server-to-NE connectivity scenarios. When timing parameters are tuned, network utilization and Prime Optical 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-25 describes the fields in the NE Service pane.

Step 3 Click the NE Poller tab and enter the NE health poll interval.

Step 4 In the Control Panel window, expand the NE Service and click an NE. Table 4-26 describes the fields in the individual NE Service panes.

Step 5 In the Resync Scheduling area of the individual 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 adversely impact server performance.

Step 6 Click Save . Changes take effect immediately.

Viewing the Individual NE Service Panes

The individual NE Service panes in the Control Panel window allow you to stop, start, or configure an individual NE service instance.

Configuring Automatic NE Backup Parameters

Prime Optical can be configured to automatically back up ONS 15216 EDFA2, ONS 15216 EDFA3, ONS 15310 CL, ONS 15310 MA SONET, ONS 15310 MA SDH, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH 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 /15600- YYYYMMDDHHMM -auto.cfg
• $CTMHOME/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, 2006 is represented as 200609291601.

• 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 NEs running configuration or startup configuration.

Note Automatic backup is not available for all NEs.

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 Auto Backup tab. Table 4-25 provides descriptions.

Step 3 Enter the following information:

• Select Modify Mode
• NE Model
• Enable Auto Backup
• Number of Backup Copies Retained
• Backup Time
• Backup Data (available only if ONS 15600 SONET or ONS 15600 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.

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.

To verify whether Prime Optical is automatically backing up the NE, go to the Job Monitor table ( Administration > Job Monitor ), 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 Prime Optical server restarts after the scheduled automatic backup time for that day, Prime Optical automatically schedules a backup for all ONS 15327, and ONS 15454 SONET NEs to take place 5 to 10 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 Prime Optical server restarts at 8:00 p.m., the server schedules a backup 5 to 10 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 Prime Optical 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.

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-25 provides descriptions.

Step 3 Enter the following information:

• Select Modify Mode
• NE Model
• Number 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.

CTC IIOP Port Configuration

The CTC IIOP Port Selection dialog box allows you to configure individual CTC IIOP ports, or a range of ports, for the CTC-based NE service.

Typically you would configure a specific CTC IIOP port (or a range of ports) if you have a firewall between the Prime Optical 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 NE Service to open the NE Service pane.

Step 3 Click the NE Poller tab.

Step 4 Click the Edit CTC IIOP Port Range button to open the CTC IIOP Port Selection dialog box, which allows you to select CTC IIOP ports or a range of ports for the CTC-based NE service. Table 4-27 provides descriptions.

Step 5 Enter the port values.

Note You can specify a single port (leaving the To text field blank) or a port range by specifying the initial value (From text field) and the end value (To text field).

Step 6 Click the Add Port button to add the ports you entered. The ports are added to the Selected Port list in ascending order.

Tip You can remove ports from the Selected Port list by selecting the port you want to remove and clicking the Remove button. The port moves to the Deleted Port list.

Step 7 Click OK to close the CTC IIOP Port Selection dialog box. At the confirmation prompt, click OK . The values displayed in the Selected Port list are formatted and displayed in the CTC IIOP Port Range field.

Viewing and Modifying Service Instance Properties

The NE Service Instance pane in the Control Panel window allows you to view a list of NEs managed by the service instance. You can also 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, expand NE Service .

Step 3 Expand an individual NE service and click NE Service Instance . The following table provides descriptions.