Cisco Prime Optical Installation Guide, 10.7

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Cisco Prime Optical Installation Guide, 10.7

Chapter Title

Appendix A: Prime Optical and Sudo Commands

Results

Updated:
May 31, 2018

Chapter: Appendix A: Prime Optical and Sudo Commands

Prime Optical and Sudo Commands

This section describes the commands that can be used during Prime Optical installation and troubleshooting.

Prime Optical Commands

Table A-1 describes the Prime Optical commands that can be used during installation and troubleshooting. To issue each command, log in to the Prime Optical server workstation and enter the command on the command line.

 

Table A-1 Prime Optical Commands

Command
Description

opticalctl start

A complete set of administrative command scripts is added to the application during installation. One command automatically starts the Prime Optical server processes every time the server is started. The server processes can also be started or stopped manually as necessary; the scripts are located in the /opt/CiscoTransportManagerServer/bin directory.

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

It can take from 0 to 5 minutes for the server processes to start after the opticalctl start command has finished execution. This is because NE services and gateway services (if enabled) are still initializing for all of the NEs that are deployed.

Five minutes after entering the opticalctl start command, enter the opticalctl status command. By this time, the NE service corresponding to all the deployed NEs should have started.

opticalctl stop

The opticalctl stop command stops the Prime Optical server gracefully. The stop procedure shuts down the server and cleans all memory and connections. The overall process takes approximately 5 minutes.

opticalctl abort

The opticalctl abort command kills all of the running processes and stops the Prime Optical server. The overall process takes no longer than 2 to 3 minutes.

opticalctl status

The opticalctl status command provides Prime Optical version and process information. The following options are available:

  • opticalctl status -h —Shows help information about all options available.
  • opticalctl status -c —Shows TCP/LISTEN and UDP open connections of application processes.
  • opticalctl status -a —Shows all connections of application processes.
  • opticalctl status -v —Shows all application processes.

For example:

opticalctl status -c -a

Sudo Commands

Note Only a Prime Optical root user (chosen during installation) can use sudo commands.

Sudo software (freeware) version 1.6.9 is bundled with the Prime Optical software. The sudo software enables nonroot UNIX users to run UNIX commands throughout the installation process. The following commands are available:

  • opticalctl start
  • opticalctl stop
  • opticalctl abort
  • opticalctl status
  • prune_auditlog.sh
  • prune_errlog.sh
  • prune_audittrail.sh
  • prune_fm.sh
  • prune_pm.sh
  • prune_ne.sh
  • prune_server_monitor.sh
  • prune_admin_job_table.sh
  • prune_ne_ipaddress.sh

Note You can still use the following legacy commands in Prime Optical:

– ctms-start

– ctms-abort

– ctms-stop

– showctm

If you selected the Install Sudo Software option during the Prime Optical server installation, the setup program prompts you to specify the name of the UNIX group to which you want to assign administrator privileges. By default, this group is set to the root group. If you specify a group other than root, the setup program verifies that the UNIX group exists on the system and adds entries to the /etc/sudoers file. Entries in this file reflect the commands that the specified UNIX group can run by using the sudo command.

To issue each command, log in to the Prime Optical server workstation as a root user or optusr and enter the command on the command line.

 

Was this Document Helpful?

FeedbackFeedback

Contact Cisco