Cisco Prime Optical 10.6 Quick Start Guide
Assumptions and Limitations of This Guide
Disk Space and Partition Requirements
Client-Server Communication Ports and Protocols
Client-Database Communication Ports and Protocols
Client-NE Communication Ports and Protocols
OSS CORBA Client Communication (Northbound) Ports and Protocols
Server-Database Communication Ports and Protocols
Loopback Connections (Server to Server) Ports and Protocols
Southbound Communication Ports and Protocols
TCP Ports for SOCKS Proxy Server
Enabling SSH on the Prime Optical Server and Database Workstation
Preparing the Environment for a Single-Server Installation
ISO Image or OVA Package Verification
Preparing the Server for Prime Optical Installation
Installing Prime Optical on the Server
Getting Started with Prime Optical
Creating a Prime Optical User A ccount
Configuring a User for Server-to-NE Connection
(Optional) Configuring Automatic Alarm Acknowledgement
This guide will get you quickly up and running with Prime Optical 10.6. This guide provides steps that lead you through a new installation for a single-server setup with an embedded database. The purpose of this guide is to quickly get you up and running with Prime Optical 10.6.
If your Prime Optical deployment differs from what is described in these assumptions, see the Cisco Prime Optical 10.6 Installation Guide or contact your Cisco account representative for assistance with planning and installing Prime Optical.
The guide assumes the following:
– Basic internetworking terminology and concepts
– Network topology and protocols
– Microsoft Windows 7 and Windows 8
– Red Hat Enterprise Linux (RHEL) administration
– Oracle database administration
– Telecommunications Management Network (TMN) architecture model
Review the prerequisites and recommendations for the hardware and software you need to support your Prime Optical deployment. These recommendations are based on the assumptions and target setup for this guide, as described in System Requirements. If your network setup is not covered by this guide, see the Cisco Prime Optical 10.6 Installation Guide.
The following topics are covered:
Table 1 lists the platforms that are supported in Prime Optical.
Note The Prime Optical server must run on a dedicated workstation. Any application that is not explicitly listed in Table 1 as being required or supported by Prime Optical cannot be installed on the dedicated Prime Optical server workstation.
Cisco UCS B series 1 |
|
1.See the appropriate UCS compatibility matrix to verify which RHEL release is supported by each platform. |
Table 2 lists the items required to install the Prime Optical server.
Sun Microsystems Java Development Kit (JDK) Standard Edition version 1.7.0_101 |
JDK is installed automatically for the Prime Optical server and Prime Optical GateWay/CORBA. |
Oracle licenses can be purchased either for the server processor or for named users. For more information on Oracle named users, see the Cisco Prime Optical 10.6 Installation Guide. |
|
Prime Optical uses GNU tar to extract files from archives. GNU must be installed on the Prime Optical server workstation. |
The following tables list hardware requirements for installing the Prime Optical server.
Table 3 lists the minimum processor requirements.
Note It is possible to use and configure disk arrays for database storage with any type of Redundant Array of Inexpensive Disks (RAID) layout. You can do so only if the disk throughput is equal to or higher than the throughput calculated for internal disks.
UCS B or C Series
2
|
|
---|---|
Cisco tests the simulated network configurations using the Enterprise Edition Oracle database type listed in Table 4. Your setup and performance might vary depending on the size of your network and the usage pattern of management tasks.
Note 8 GB of RAM is required for the small size, but Cisco recommends 16 GB. |
|||
The following list describes the server configuration parameters and the effect of changes in each parameter on the maximum number of NEs the server can manage:
Table 5 and Table 6 show disk space and partition requirements for NEs based on network size and performance management (PM) data collection status:
– Dynamic multipathing (DMP) to parallelize the file system access.
– Raid 0 (striping) to optimize the disk input data.
Note the following PM assumptions for optical NEs:
The ctm_backup directory is a repository used by the Oracle user to back up the following main categories of information:
The Oracle user must have read/write permissions or the database backup will fail. The database could be blocked if the ARCHIVELOG files cannot be moved to the /ctm_backup directory.
We recommend that the /ctm_backup size be equivalent to the sum of the single database partitions (that is, the sum of /oracle, /db01, /db02, /db03, /db04, /db05, and—if configured—/db01_rd and /db02_rd).
The /ctm_backup directory can be a symbolic link to a user-defined directory and must have read/write permissions.
For more information on Ports and Protocols, see chapter 2 of the Cisco Prime Optical 10.6 installation guide.
Inbound ports are for operations initiated by the Prime Optical client and then directed to the Prime Optical server. Outbound ports are for operations initiated by the Prime Optical server and then directed to the Prime Optical client.
See Table 7 for client-server port and protocol information.
The Prime Optical client uses Java Database Connectivity (JDBC) to communicate directly with the Prime Optical database, independently from the Prime Optical server.
See Table 8 for client-database port and protocol information.
The Prime Optical client can launch Cisco Transport Controller (CTC) and CEC as external applications. The ports and protocols used by these application are detailed in their end-user documentation.
Table 9 lists the ports and protocols used for communication between the Prime Optical server workstation and the Operations Support System (OSS) CORBA client workstation.
Table 10 lists the ports and protocols used for communication between the Prime Optical server and database.
The Prime Optical server establishes the internal connections listed in the following table. Although operating system commands (for example, netstat) show services listening on these ports, they do not need to be opened on a firewall because there is no incoming connection on these ports from other hosts.
Table 11 lists the ports and protocols used for loopback connections.
The following tables list the ports that the Prime Optical server uses to communicate with NEs.
Table 12 lists CTC-based NE ports without Multi-Layer (ML) cards.
Table 13 lists CTC-based NE ports with ML cards.
Note The ports and protocols listed in Table 13 are used in addition to the ones listed in the previous table.
Table 14 lists Cisco ONS 15216 ports.
Table 15 lists Cisco ONS 15305 (non-CTC-based) ports.
Table 16 lists Cisco ONS 15305(CTC-based) ports.
Table 17 lists the TCP ports to use in a sockets network proxy protocol (SOCKS) server configuration. This information is helpful when setting up a firewall routing table.
To install the Prime Optical client, you must have a Linux or Windows PC. Memory, CPU, and disk requirements are listed in Table 18.
The delta RAM and delta CPU must be counted for each additional launched client.
Disk Space Without CEC
14
|
Other
15
|
||||
---|---|---|---|---|---|
|
12.If you plan to run multiple Prime Optical client sessions on a single client workstation, add 512 MB of RAM and a 240 MHz CPU for each additional Prime Optical client. |
Table 19 shows the maximum number of simultaneous Prime Optical client sessions by network size.
Before installing Prime Optical, you must perform the following preinstallation tasks:
To enable you to install Prime Optical, the Prime Optical server must be able to use secure shell (SSH) to run commands on the database workstation.
Step 1 As the root user, enter the following command to start the SSH service:
Step 2 Edit the /etc/ssh/sshd_config file on the Prime Optical workstation and change the PermitRootLogin value to yes.
Step 3 Enter the following command on the Prime Optical workstation to make the changes take effect:
Step 4 If you are installing the Prime Optical server and database on two different workstations, repeat the preceding steps on the Prime Optical database workstation.
Make sure that the file /etc/hosts contains the following row:
where ipaddress and hostname are the IP address and the hostname of the local servers.
To install the required Red Hat Package Manager (RPM) utility for the Linux server and database, you must enable yum commands.
Ensure that the yum command is properly configured and that the yum repository is available. Enter the following command to verify that at least one valid repository is configured:
If yum is not configured, you can register your system on Red Hat Network (RHN) or configure the yum command on a local repository.
Note If yum is configured on RHEL registration, ensure that the system has access to the external network.
To configure yum commands on a local repository:
Create a local.repo file in /etc/yum.repos.d directory and configure the local.repo file to the RHEL DVD.
Step 1 Copy the proper local.repo file template from DVD-mount-point/Disk1 to /etc/yum.repos.d directory.
You can find a local.repo template for RHEL5.x, RHEL6.x and RHEL7.x in Disk1 of the Prime Optical installation DVD.
For RHEL 5.x installation, use the following command:
For RHEL 6.x installation, use the following command:
Step 2 Open your /etc/yum.repos.d/local.repo file and follow instructions to mount RHEL DVD and configure yum local repository on RHEL DVD.
You must prepare the environment for Prime Optical server and Oracle database installation on the same server.
Note This feature is available only if you choose root user instead of optusr as the Prime Optical user during installation.
Step 1 Log in as the root user.
Step 2 Enter the following command to verify that the disk directories shown in Table 20 exist:
Used for the Prime Optical installation. It includes.jar files, executable shell scripts, and so on. |
|
/db01_rd 16 |
|
Used for the Prime Optical base data tablespace, alarm data tablespace, and event data tablespace. |
|
/db02_rd 1 |
|
/ctm_backup 17 |
Used for the Prime Optical backed-up database and configuration files. |
Note Disk partitioning is not required for /tftpboot, but the directory is required. |
16.To optimize system performance, see Disk Space and Partition Requirements. |
Step 3 Check the content of the /etc/sysconfig/selinux file.
If the file contains SELINUX=enforcing, do the following:
a. Change the entry to SELINUX=disabled or SELINUX=permissive.
c. Disable the server by running one of the following commands:
chkconfig iptables off
or
service iptables stop
Before installing Cisco Prime Optical, you need to verify the ISO image or OVA package.
Download the product installation file (OVA or ISO), its signature, and the certificate file to a separate Unix/Linux system and perform the following steps:
Step 1 If you do not have openssl installed, download and install it (see http://www.openssl.org).
Step 2 Place the following files in a temporary directory:
Step 3 Move to the temporary directory and execute the following command:
cert-file is the Cisco Prime Optical certificate file
sig-file is the Cisco Prime Optical signature file
product-file is the Cisco Prime Optical ISO file or OVA image to be verified
Step 4 If the result is Verified OK :
Step 5 (OVA package only) Verify the publisher and certificate chain using the VMware vSphere client.
a. Verify that Cisco Systems is the publisher.
– In the vSphere client, choose File > Deploy OVF Template.
– Browse to the OVA installation file (*.ova) and select it, then click Next.
– Check whether the Publisher field in the OVF Template Details window displays Cisco Systems, Inc with a green check mark next to it.
Note Do not validate the image using the information in the Vendor field as this field does not authenticate Cisco Systems as the publisher.
Note Do not proceed if the Publisher field displays No certificate present. This indicate that the image is not signed or the file is not from Cisco Systems or it has been tampered with. Contact your Cisco representative.
b. Check the certificate chain.
– In the OVF Template Details window, click the Cisco Systems, Inc. hyperlink in the Publisher field.
– In the Certificate window, click the Certification Path tab.
– In the Certification Path tab (which lists the certificate chain), ensure that the Certification Path area displays Cisco Systems, Inc. and the Certificate Status displays The certificate is OK.
Note The ISO Image or OVA Package Verification is valid only if the OVA/OVF file is obtained as a BU Digital download through cisco.com.
Installing Prime Optical on a single-server with an embedded database is a two-part process:
1. Prepare the server for installation.
Before you install Prime Optical, you must first connect to the server and, if using X server, verify the display settings.
To prepare the server for Prime Optical installation:
Step 1 As the root user, launch a terminal on the server where you want to install Prime Optical. (If you logged in as a nonroot user, enter the su - command to become the root user.)
Step 2 Enter the following command to set the DISPLAY variable:
Step 3 Enter the following command to verify that the display is set correctly:
In the command output, you should see:
Step 4 If you are using an xterm window or a remote host, enter the following command to enable the xterm connection from the clients:
As part of your Prime Optical installation, you will install the Prime Optical server and Oracle 12c database on the same RHEL server.
To install Prime Optical, do the following:
Step 2 Enter the following command to set the DISPLAY variable:
Step 3 Enter the following command to verify that the display is set correctly:
In the command output, you should see:
Step 4 If you are using an xterm window or a remote host, enter the following command to enable the xterm connection from the clients:
Step 5 Insert the Cisco Prime Optical Server installation DVD - Linux into the DVD drive.
Step 6 If you have the Cisco Prime Optical server installation ISO image instead of the DVD media, enter the following commands to mount it:
Step 7 Navigate to the Disk1 directory and enter the following command to start the installation:
Make sure that the /tmp directory has at least 10 GB of free space. If not, use a different directory.
This command begins the installation. The following happens:
The setup program searches for Sun Microsystems JDK version 1.7.0_101 on your workstation.
The Cisco Prime Optical Server Installation wizard appears. Wait for up to 90 seconds while the following message appears:
Step 8 In the Introduction window, click Next.
Step 9 In the License Agreement window, read the license agreement and click the I accept the terms of the license agreement radio button. Click Next.
Step 10 In the Configure the Server and Database window, do the following:
a. From the list of Prime Optical installation types, choose the Prime Optical server and database radio button to install the Prime Optical server along with the database.
b. Verify that the correct hostname or IP address is shown for the Prime Optical server, then click Next. For proper configuration, a fully qualified domain name must be provided.
Note The Database field is disabled when the server and database are installed on the same workstation. Prime Optical automatically uses the server hostname or IP address.
Step 11 In the Configure the Database window, choose Embedded. If a previous version of Oracle is detected on your system, click Continue to delete it and continue the installation.
Step 12 In the Operating System User window, select a user type, and then click Next. (For field descriptions, see Table 21 .)
Step 13 In the Select Network Configuration window, specify the size of your network, and then click Next.
Step 14 Review the preinstallation checks, and then click Next.
A warning message appears during the preinstallation checks. If the installation continues, you can ignore the message; if the installation quits, see the topic on downloading and installing Oracle packages.
Step 15 In the Optional Features window, choose additional features, and then click Next. (For field descriptions, see Table 21 .)
Step 16 In the Destination Folder window, specify where you want to install the Prime Optical server, and then click Next.
If the destination directory that you specified is a new directory, you will receive the message, “The specified directory does not exist. Do you want to create it?” Click Yes.
Note Do not delete any instances of /opt/CiscoTransportManagerServer from your Prime Optical file structure. Prime Optical checks for the /opt/CiscoTransportManagerServer directory or a symbolic link to it. If Prime Optical cannot find either, it automatically creates a symbolic link.
Step 17 In the Pre-Installation Summary window, click Install. If you get a message telling you that SSH is not configured, verify that PermitRootLogin is set to Yes in the /etc/ssh/sshd_config file, and then click Continue.
Step 18 Enter the root password and follow the prompts to configure the SSH connection and continue the installation.
Step 19 In the Web Server Installation Summary window, click Next,
Step 20 In the Install Complete window, click Done.
Step 21 As the root user, enter the following command to reboot the system and automatically start the Prime Optical server:
After the server reboot, it might take up to 20 minutes for the Prime Optical server to come up.
Table 21 describes the required information for your Prime Optical embedded database installation.
To verify that Prime Optical was installed correctly:
Step 1 Enter the opticalctl status command after the server reboots to verify that the server is running.
The opticalctl status command displays the Prime Optical server version running as 10.6, followed by the build number. In the command output, you must see two instances of “Prime Optical Server,” “SnmpTrapService,” “SMService,” “Apache Web Server,” “TOMCAT,” and “OrchestrationService.” This indicates that the server is running.
Step 2 Verify that the client launches. See Launching the Client.
Uninstalling the Prime Optical server automatically uninstalls the Web Server, which cannot be uninstalled on its own.
Note If Prime Optical is installed with an embedded database, the Oracle 12c software and Oracle operating system user are removed automatically along with the Prime Optical server.
Step 1 Log in to the Prime Optical server as a root user and enter the following command, where version is the specific version of the Prime Optical server that you want to uninstall:
For example, enter the following command to uninstall Prime Optical 10.6:
Step 2 When prompted to confirm the uninstallation, be sure to type your response in all capital letters, or the installer will quit. Enter YES.
The Prime Optical client uses Java Web Start technology. When the Prime Optical administrator updates or patches the server, the client is updated automatically.
To launch the Prime Optical client:
Step 1 Open a Prime Optical-supported web browser and enter the following URL:
where server-hostname is the hostname of Prime Optical.
Step 2 Accept the self-signed, untrusted security certificates. (If your browser is Internet Explorer, place the security certificates in the trusted certificate store; otherwise, they will reappear upon subsequent logins.)
Step 3 The first time you log in, enter the case-sensitive username and password defaults:
Step 4 When prompted, change the password, and then click OK. (For password complexity rules, see Password Complexity Rules.)
Step 5 From the Prime Optical Home page menu, choose Start and select a Domain Explorer.
If you choose the SOCKS option, you must configure a SOCKS v5 proxy server address and port value. If a SOCKS server is not configured, you will connect to the Prime Optical server directly. See Configuring a SOCKS Server for information on how to configure a SOCKS server.
Note When Prime Optical is installed with Prime Central, you can launch the Domain Explorer from the Prime Central portal only.
Step 6 Click OK at the advisory message.
After the Java Web Start window appears and downloads the Domain Explorer, one of the following may occur:
If the client does not start, check that Java Runtime Engine (JRE) 1.7 (version less than 100) or 1.8 (version less than 100) is installed on the machine, and that Java Web Start is associated to the browser with the correct javaws.
Password complexity is configurable through the Prime Optical UI (Control Panel > Security Properties pane). By default, the password must:
To configure a SOCKS v5 proxy server address and port value to manage connectivity through network firewalls:
Step 1 From the Home page, choose Administration > SOCKS Table.
Step 2 Click Add Row, and then enter the hostname or IP address and the TCP port number for the SOCKS host.
Step 4 Click the radio button next to the row with the SOCKS server settings you want to use the next time you log in, and click Save as Default. (Each user must select a default SOCKS server.)
These procedures will get you started quickly with using Prime Optical. These procedures are high-level and do not include field descriptions.
Table 22 lists high-level tasks and the related topic in the Cisco Prime Optical 10.6 user guide where you can find more information.
Log in as SysAdmin to create a SuperUser account.18 |
||
Log in as SuperUser to configure the server NE user and password from the Control Panel.
|
||
(Optional) Configure automatic alarm acknowledgment from the Control Panel. |
||
Verify that the NE software version exists in the Supported Devices Table. |
||
(Only for WSE management) Create SecurityAdmin and SecurityProvisioner profiles19 |
18.If WSE cards are provisioned, in addition to creating a SuperUser account, you must create a Security Admin account. See the User Profiles and Roles in the user guide for more information. 19.When WSE cards are provisioned, there are additional security profiles and privileges that should be created. See User Profiles and Roles in the user guide for more information on the function of each security profile. |
Note This functionality is disabled when Prime Optical is installed as part of Prime Central.
You must create a SuperUser account to start Prime Optical configuration.
To create a SuperUser account:
Step 1 In the Domain Explorer window, choose Administration > Users.
Step 2 In the Prime Optical Users table, choose Edit > Create.
Step 3 In the Create New User wizard, fill in the appropriate fields.
Step 4 Click Next. When you are finished adding new user accounts, click Finish.
To configure a user for the Prime Optical server to use to connect with NEs:
Step 1 In the Domain Explorer window, choose Administration > Control Panel.
Step 2 Click Security Properties and set the appropriate parameters. (If many tabs are displayed in the properties pane, click the arrow or Show List icons to view all available tabs.)
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.
Step 3 After making your selections, click Save.
Automatic backup is not available for all NEs.
To enable NE automatic backup:
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 Auto Backup tab.
Step 4 Enter the necessary information.
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.
To verify that 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 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.
See the Cisco Prime Optical 10.6 Documentation Overview for a list of Prime Optical guides.
For information on obtaining documentation, submitting a service request, and gathering additional information, see What’s New in Cisco Product Documentation at http://www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html.
Subscribe to What’s New in Cisco Product Documentation, which lists all new and revised Cisco technical documentation, as an RSS feed and deliver content directly to your desktop using a reader application. The RSS feeds are a free service.