Installing SGM on Linux

Table Of Contents

Installing SGM on Linux

Overview of Installing SGM

Prerequisites for Installing SGM

Upgrading SGM

Becoming the Root User

Installing the SGM Server

Installing SGM to a Different Directory

Specifying Alternate Ports

Verifying SGM Installation

Checking for Error Messages

Viewing Packaging Information for the SGM Server

Verifying the Installation Directories

Starting SGM

Uninstalling SGM

Overview of Uninstalling SGM

Running the Uninstall Program

Installing SGM on Linux

---

This chapter describes how to install the SGM server software on a Linux system. It also provides information about verifying the SGM installation and uninstalling and reinstalling SGM on Linux.

This chapter includes the following sections:

•Overview of Installing SGM

•Prerequisites for Installing SGM

•Upgrading SGM

•Becoming the Root User

•Installing the SGM Server

•Installing SGM to a Different Directory

•Specifying Alternate Ports

•Verifying SGM Installation

•Starting SGM

•Uninstalling SGM

Overview of Installing SGM

You can install the SGM server software on a Linux system using the following installation menu option:

•Install SGM Server

---

Note For details on the Install SGM Call Data Mediation Service option, see "Installing CDM on Linux."

---

The SGM software consists of the following Linux RPM packages:

•SGM server (CSCOsgm-s, CSCOsgm-j2re, CSCOsgm-web)

When the SGM installation program prompts you for a response, it displays the default value for each prompt in square brackets [ ]. To accept the default value, press Return. (When in doubt, accept the default.)

SGM also verifies the availability of all values, such as port numbers, before accepting them.

To stop the SGM installation program at any time, press Ctrl-C.

If you attempt to install SGM in one window while installing another product in another window, the SGM installation fails. If this situation occurs, wait until all other product installations are complete, then enter the following command from the top of the SGM CD Image:

./uninstall.sh -n

This command removes all SGM components and restores your system to a clean state. Then reinstall SGM.

Prerequisites for Installing SGM

Before you run the SGM installation program:

•Make sure your Linux system meets the requirements listed in "Preparing to Install SGM."

•Determine whether you want SGM to receive SNMP traps:

–If you want SGM to receive traps natively, determine whether SGM is to receive traps on the standard UDP port number 162 or on another port. For example, if your ITPs have been configured to send traps to a different port, or if trap multiplexing devices and NMS applications in your network have been configured to send traps to a different port, you need to specify that port number when prompted by the SGM installation program.

•Determine whether you want to configure SGM Security Services, and whether you want local-based or Linux-based authentication. For more information, see the "Configuring SGM User-Based Access" section in the Cisco Signaling Gateway Manager User Guide.

•Determine whether CiscoWorks2000 is installed on your system, whether you want to integrate SGM with CiscoWorks2000, and the name and port number for the CiscoWorks2000 Web server. The default port number is 1741.

•Determine whether you want the SGM server to automatically discover your network the first time the server starts after installation. If so, determine the name or IP address of the node you want to use as a seed node. For more information about the Discovery process and how to use seed nodes, see the "Discovering the Network" section of the Cisco Signaling Gateway Manager User Guide.

Upgrading SGM

If you are upgrading SGM to a new version and release (for example, from SGM 3.3 to SGM 4.0), keep the following considerations in mind:

•SGM converts the following configuration information, as necessary, to be compatible with the new version and release of SGM:

–SGM database—SGM converts all network object configuration information in the SGM database.

–User views—SGM converts each user's view settings.

–Network event information, including the event log and customized event help files, but not including event filter settings

–Customized point code formats and network configurations

–SNMP parameters

–GTT configuration files

–Route table configuration files

–Seed node files

–Notes about objects, events, and so on

–IP access list

–Trap access list

•SGM replaces following configuration information with the latest configuration:

–Network event configuration. SGM also preserves the old event configuration file as SgmEvent.conf.sgm33.

If you customized the SgmEvent.conf file in SGM 3.3, the SgmEvent.conf file in SGM 4.0 does not include those customizations. If you want to retain those customizations, replace the new SgmEvent.conf with the old SgmEvent.conf.sgm33. If you do so, SGM uses default values for any new fields or capabilities in the file.

•SGM does not maintain the following configuration when you upgrade to a new version and release of SGM:

–User preferences

–Network event filter settings

•If you are upgrading from SGM 2.2, you must first upgrade to SGM 3.0, then to SGM 3.1, then to SGM 3.2, then to SGM 3.3, then to SGM 4.0.

–To upgrade from SGM 2.2 to SGM 3.0, refer to the Cisco Signaling Gateway Manager Installation Guide for SGM 3.0.

–To upgrade from SGM 3.0 to SGM 3.1, refer to the Cisco Signaling Gateway Manager Installation Guide for SGM 3.1.

–To upgrade from SGM 3.1 to SGM 3.2, refer to the Cisco Signaling Gateway Manager Installation Guide for SGM 3.2.

–To upgrade from SGM 3.2 to SGM 3.3, refer to the Cisco Signaling Gateway Manager Installation Guide for SGM 3.3.

Becoming the Root User

To install and configure SGM, you must be logged in as the root user on the system where you want to install SGM.

---

Caution As the root user, you can adversely affect your operating environment if you are unaware of the effects of the commands you use. If you are a relatively inexperienced UNIX user, limit your activities as the root user to the tasks described in this manual.

---

If you are not logged in, log in as the root user:

> login: root

> Password: root-password 

If you are already logged in, but not as the root user, use the su command to change your login to root:

# su

# Password: root-password

Installing the SGM Server

This procedure assumes that you have not already installed the SGM server or client on this workstation. If you have already installed the SGM server or client on this workstation, some steps might be added, some might be different, and some might be unnecessary and ignored by SGM.

To install the SGM server, complete the following steps:

---

Step 1 Log in as the root user, as described in the "Becoming the Root User" section.

Step 2 Mount the CD-ROM drive, as described in "Mounting and Unmounting the CD-ROM Drive on Solaris/Linux."

Step 3 Change to the mounted directory using the cd command:

# cd /mnt/cdrom/linux

Step 4 Start the installation script by entering the following command:

# ./setup.sh

---

Note If you are installing SGM using an NFS-exported CD-ROM drive, image checking might take several hours to complete. To avoid this problem, enter ./setup.sh -i, which disables image checking.

---

Step 5 The SGM installation program displays the installation menu:

1) Review README File First (Recommended)

2) Install SGM Server

3) Install SGM Call Data Mediation Service

4) Exit Setup

Please choose an option -> 

Choose one of the following options:

•To read the latest information about SGM in the README file, type 1 and press Return. The README file contains late-breaking information about SGM that might not be found in the other product documentation.

•To install the SGM server on the system, type 2 and press Return.

Step 6 The SGM server install tool begins. SGM performs a system requirements check and a TCP/IP address check. The following question appears:

The server must bind to a specific IP address. This address will be 
used by any remote client connecting to the server.

Available IP addresses

----------------------

10.255.255.255

10.0.0.0

Enter IP address to use for client communications: 

Enter the IP address you want to use, then press Return.

Step 7 SGM performs a TCP/IP port usage check, then displays the SGM server summary:

========================================================

=================- SGM Server Summary -=================

========================================================

INFO: The following parameters will be used:

INFO:   [1] Server Name     : your_sgm_server

INFO:   [2] Web Server      : 1774/tcp

INFO:   [3] JSP Server      : 1775/tcp

INFO:   [4] Naming Server   : 44742/tcp

INFO:   [5] Browser Path    : /opt/netscape/netscape

Press Return to continue ->

where your_sgm_server is the name of the SGM Server.

Press Return.

Step 8 The SGM installation program attempts to determine whether there is adequate space in the default installation directory, /opt, to install the SGM server.

•If there is adequate space, installation continues.

•If there is not adequate space, the SGM installation program asks you to specify a different directory. See the "Installing SGM to a Different Directory" section for more information. After you specify a different directory, installation continues.

The SGM installation program also checks the following directories to determine whether there is adequate space: /var/sadm, /var/tmp, and /tmp. If there is not adequate space on any of these directories, the following message appears:

There is insufficient space in <directory> for installation to 
proceed.

The installation process stops and exits.

Step 9 If you are not upgrading to a new version and release of the SGM server, continue with Step 10.

If you are upgrading to a new version and release of the SGM server, the SGM installation program displays the following prompt:

Do you want to upgrade to SGM - Server version 4.0? (y/n)? [Y]

Press Return.

The SGM installation program begins installing the SGM server, then displays the following prompt:

Press Return to continue ->

Press Return. SGM converts your version 3.3 server data to version 4.0. Skip to Step 21.

Step 10 If your system does not meet the requirements for Express Install, installation continues with Step 11.

If your system does meet the requirements, the SGM installation program displays the following prompt:

Do you want the Express Install (y/n)? [Y]

The Express Install option uses default settings, minimizing system prompts.

•To choose the Express Install, press Return, and skip to Step 17.

•To choose the standard installation, which prompts you for additional information, type n, press Return, and continue with Step 11.

Step 11 The SGM installation program displays the following prompt:

Where should the product be installed? [/opt]

To accept the default value, press Return; or type a different location and press Return.

Step 12 The SGM installation program displays the following prompt:

Which tcp port should Web Server use? [1774]

To accept the default value (recommended), press Return; or type a different, numeric port number and press Return.

(SGM works on standard Web port 80, but software installed in the future that requires port 80 might conflict with SGM.)

Do not enter a non-numeric port number. If you do, you are prompted to enter a numeric port number.

Step 13 The SGM installation program displays the following prompt:

Which tcp port should JSP Server use? [1775]

To accept the default value, press Return; or type a different, numeric port number and press Return.

Do not enter a non-numeric port number. If you do, you are prompted to enter a numeric port number.

Step 14 The SGM installation program displays the following prompt:

Which tcp port should Naming Server use? [44742]

To accept the default value, press Return; or type a different, numeric port number and press Return.

Do not enter a non-numeric port number. If you do, you are prompted to enter a numeric port number.

Step 15 The SGM installation program displays the following messages and prompt:

========================================================

=================- SGM Server Summary -=================

========================================================

INFO: The following parameters will be used:

INFO:   [1] Server Name     : your_sgm_server

INFO:   [2] Web Server      : your_web_server_port/tcp

INFO:   [3] JSP Server      : your_JSP_server_port/tcp

INFO:   [4] Naming Server   : your_naming_server_port/tcp

INFO:   [5] Browser Path    : your_browser_path

If necessary, you can change these settings after installing SGM by using the following commands:

•To change the Server Name, use the sgm servername command. The SGM client name changes to match the new server name.

•To change the Browser Path, use the sgm browserpath command.

•To change the Web Server TCP port number, use the sgm webport command.

•To change the JSP Server TCP port number, use the sgm jspport command.

•To verify the new settings, use the sgm props command.

The SGM installation program then displays the following prompt:

Press Return to continue ->

Press Return.

Step 16 If CiscoWorks2000 is not installed on your system, installation continues with Step 17.

If CiscoWorks2000 is installed on your system, the SGM installation program automatically integrates the SGM server with CiscoWorks2000 and displays the following messages:

Registering SGM Server with CiscoWorks2000 Application Registry...

Integrating SGM Server with CiscoWorks2000 Common Management 
Foundation...

CiscoWorks2000 must be restarted to register SGM menus:

/etc/init.d/dmgtd stop

/etc/init.d/dmgtd start

Integration of SGM Server with CiscoWorks2000 Complete.

---

Note This step does not start the CiscoWorks2000 server automatically. If the CiscoWorks2000 server was not running when you began installing SGM, you must start it manually.

---

Step 17 The SGM installation program displays the following prompt:

Would you like to configure SGM to receive SNMP traps? [y]

•If you do not want to configure SGM to receive SNMP traps, type n and press Return.

•If you want to configure SGM to receive SNMP traps, press Return. When you select an SNMP trap port number for the SGM server, make sure your ITPs use the same SNMP trap port number. See the description of the snmp-server host command in the "ITP Requirements" section for more information.

Step 18 The SGM installation program displays the following prompt:

Would you like to configure SGM Security Services? [n]

•If you do not want to configure SGM Security Services, press Return.

•If you want to configure SGM Security Services, type y and press Return. The SGM installation program displays the following messages and prompt:

SGM provides two types of security authentication, linux and 
local.

Local authentication allows creation of user accounts and 
passwords local to the SGM system. When using this method, user 
names, passwords, and access levels are managed using SGM 
commands.

Linux authentication uses the standard linux-based user accounts 
and passwords as specified in the /etc/nsswitch.conf file. Using 
this method, authentication can be provided by the local 
/etc/passwd file or from a distributed NIS or Kerberos system. 
When using this method, access levels are assigned to user 
accounts using SGM commands, but all user names and passwords are 
managed using linux commands.

The valid choices for authentication type are linux and local.

Please choose the type of authentication to use: [local]

–If you want SGM to use local-based authentication, press Return. The SGM installation program displays the following message:

Authentication type set to: local.

–If you want SGM to use Linux-based authentication, type linux and press Return. The SGM installation program displays the following message:

Authentication type set to: linux.

The SGM installation program then displays the following messages:

User-Based Access Protection Is Enabled.

Use the "sgm adduser" command to add users.

Log in with user names and passwords for access to SGM features.

Step 19 The SGM installation program displays the following prompt:

Would you like SGM to discover your ITP network after startup? [n]

•If you want the SGM server to automatically discover your network the first time the server starts after installation, type y and press Return.

The SGM installation program displays the following prompt:

Enter name of ITP to use to seed discovery:

Type the name or IP address of a seed node and press Return.

---

Note SGM does not verify that the node name you enter is a valid node name.

---

For more information about the Discovery process and how to use seed nodes, see the "Discovering the Network" section of the Cisco Signaling Gateway Manager User Guide.

•If you do not want the SGM server to automatically discover your network the first time the server starts after installation, press Return.

Step 20 If the TFTPD server on this system is enabled, installation continues with Step 21.

If the TFTPD server on this system is not enabled, the SGM installation program displays the following messages and prompt:

The TFTPD server on this system is not enabled.

If you plan to use this system as a TFTPD server to send configuration 
files to ITP devices, enable the TFTPD server and ensure that it is 
working properly.

Check the etc/inetd.conf file for an entry similar to:

   tftp dgram upd6 wait root /usr/sbin/in.tftpd in.tftpd -s /tftp boot

and make sure the line is not commented out.

Press Return to continue ->

Check the specified line in the etc/inetd.conf file, then press Return.

Step 21 Server installation completes, and the SGM installation program displays the following message:

To use this product, set your path to:

   /opt/CSCOsgm/bin:$PATH

To access the SGM Web Server use the URL:

http://your_sgm_server:your_web_server_port

where:

•your_sgm_server is the name of the SGM Web Server

•your_web_server_port is the TCP port number used by the Web Server

This URL is required if you want to install the SGM client software using the Web interface on the SGM server.

---

Tip You can also use the Web interface on the SGM server to access server logs, system information, and SGM documentation.

---

The SGM installation program then displays the following messages and prompt:

No Errors were encountered during installation.

Please review /var/tmp/cisco_sgmsvr_install.log for detailed results.

Would you like to view the log? [n]

•If you do not want to view the log, installation is complete. Press Return.

•If you want to view the log, type y and press Return. The server installation log is displayed, followed by the prompt:

Press Return to continue ->

Press Return.

Step 22 To verify that the installation was successful, see the procedures in the "Verifying SGM Installation" section.

Step 23 The SGM installation program displays the following SGM start menu:

1) Start SGM Server Only

2) Exit Setup

Please choose an option -> 

To start SGM at this time, type one of the options and press Return. To start SGM at a later time, see the "Starting SGM" section.

---

Installing SGM to a Different Directory

To install the SGM software in a directory other than the /opt default directory, use the standard installation and specify a new location to install the SGM software.

In the following example, the SGM installation program detects insufficient space in the /opt default directory and recommends an alternate directory, /usr2, which has enough available space:

============================================================

================- Disk Space Usage check -==================

============================================================

INFO: For this product the default disk space requirements are:

        /opt                  300 MB

        /var/tmp                1 MB

        /tmp                    1 MB

INFO: Checking default disk space requirements... 

INFO: /opt has insufficient space for installation.

INFO: Express Install has been disabled.

============================================================

INFO: Local disks on this machine with enough space to install:

Filesystem            kbytes    used   avail capacity  Mounted on

/dev/dsk/c0t4d0s6    1925720  288623 1444527    17%    /usr2

Where should the product be installed? [/usr2]

To accept the recommended directory, press Return. Otherwise, specify another directory and press Return.

Specifying Alternate Ports

The SGM client and server software must be set up to communicate on the same port. If you are installing the SGM client on the same machine as the SGM server, the installation program handles this automatically. If you are installing the SGM client on a separate system from the server, you must make sure the ports specified during the client installation match those installed for the SGM server. In most installation situations the default ports should be available for the SGM client and server.

The SGM server software uses the following default ports:

•Web Server—1774/tcp

•JSP Server—1775/tcp

•Naming Server—44742/tcp

The SGM client software must know which ports the SGM server is using. By default, the client uses the following ports:

•Web Server—1774/tcp

•JSP Server—1775/tcp

•Naming Server—44742/tcp

When you install the SGM server, the SGM installation program determines whether or not these ports are available. If there are conflicts with the ports, the software provides you with the option to specify an alternate port number.

To determine the ports that are currently in use on your system, use the netstat command for Linux, which includes the corresponding port type (TCP).

# netstat -a -n -tcp

---

Note If you are specifying an alternate port, remember that ports 1 through 1023 are reserved for system processes.

---

Verifying SGM Installation

You can verify successful installation of the SGM server software by performing the following tasks:

•Checking for Error Messages

•Viewing Packaging Information for the SGM Server

•Verifying the Installation Directories

Checking for Error Messages

During installation, messages are recorded in a log file to provide diagnostic information about problems that might arise. The location of the installation log file is provided in a message at the end of the SGM installation script.

To check for installation error messages:

---

Step 1 Log in as the root user as described in the "Becoming the Root User" section.

Step 2 Use the following command to examine the SGM server installation log:

# more install_directory/install/cisco_sgmsvr_install.log

Where install_directory is the directory in which SGM was installed. The default installation directory for SGM is /opt/CSCOsgm.

Step 3 Press the Space bar to scroll through the display one screen at a time.

---

You can also display the SGM server installation logs using the sgm installlog command. For more information, see the "SGM Command Reference" appendix in the Cisco Signaling Gateway Manager User Guide.

Viewing Packaging Information for the SGM Server

You can use the rpm command to verify that the SGM server (CSCOsgm-s) software package is installed on your system.

To view packaging information for the SGM server:

---

Step 1 Enter one of the following rpm commands:

# rpm -qi CSCOsgm-s

# rpm -qi CSCOsgm-j2re

# rpm -qi CSCOsgm-web

Step 2 Verify that you receive output similar to the following display:

Name: CSCOsgm-s                     
Relocations: /opt/CSCOsgm 

Version: 4.0  
Vendor: Cisco Systems, Inc.

Release: 01                             
Build Date: Thu 24 Mar 2005 03:39:41 AM EST

Install Date: Thu 24 Mar 2005 11:46:22 AM EST       
Build Host: localhost.localdomain

Group: Cisco/Network Management       
Source RPM: CSCOsgm-s-4.0.0-01.src.rpm

Size: 46897678                          
License: Copyright 2005 Cisco Systems, Inc.

Signature: (none)

Summary: Cisco Signaling Gateway Manager - Server

Description: The Cisco Systems Signaling Gateway Manager.

If the package was not found, one of the following messages are displayed:

package "CSCOsgm-s" is not installed

package "CSCOsgm-j2re" is not installed

package "CSCOsgm-web" is not installed

The SGM software package was not installed. Install SGM again.

---

Verifying the Installation Directories

After you install SGM, use the ls command to verify that you have a new directory structure containing the SGM software.

•For the SGM server, the default directory is /opt/CSCOsgm.

•If you installed SGM in a directory other than /opt, then the CSCOsgm directory is located in that directory.

Starting SGM

After you install the SGM server, verify that you can start the SGM software. You can start the SGM software by selecting the corresponding option on the start-up menu after the installation program is complete.

You can also start the SGM server from the command line.

There is no harm in attempting to start an SGM server if it is already running.

---

Note The following procedures assume that you installed SGM in the default directory, /opt. If you installed SGM in a different directory, change to that directory instead of /opt.

---

To start just the SGM server from the command line, log in as the root user and use the following commands:

# cd /opt/CSCOsgm/bin

# ./sgm start

For a complete list of all of the SGM commands, see the "SGM Command Reference" appendix in the Cisco Signaling Gateway Manager User Guide.

If the SGM server installation was successful, and if you did not configure the SGM server to automatically discover your network the first time the server starts after installation, SGM displays the Discovery Dialog (Figure 3-1) and the SGM Main Window (Figure 3-2).

Figure 3-1 Discovery Dialog

Figure 3-2 SGM Main Window

Because the SGM database contains no information, the SGM Main Window is blank. The database is populated, and reflected in the SGM Main Window, when you run Discovery for the first time; SGM displays the Discovery Dialog to make it easier for you to do so. In fact, any time you start the SGM client and the SGM database is empty, SGM automatically opens the Discovery Dialog so you can run Discovery and populate the database. For more information about Discovery, see the "Discovering the Network" section of the Cisco Signaling Gateway Manager User Guide.

Uninstalling SGM

The uninstall program provides you with a menu similar to that presented for installation.

Uninstalling SGM is discussed in the following sections:

•Overview of Uninstalling SGM

•Running the Uninstall Program

Overview of Uninstalling SGM

When you run the uninstall program, remember the following information:

•If you have already installed SGM and you are upgrading to a new version or release, SGM automatically preserves all data necessary for a successful upgrade. However, if you uninstall SGM before upgrading, all SGM data is also uninstalled, and is lost.

•The default for each prompt is the value in square brackets [ ]. To accept the default value, press Return.

•To stop the installation script at any time, press Break or Ctrl-C.

Running the Uninstall Program

To uninstall the SGM software:

---

Step 1 Log in as the root user as described in the "Becoming the Root User" section.

Step 2 If you are running an SGM client locally, exit all open SGM windows.

---

Tip To display a list of all SGM clients that are connected to the SGM server, use the sgm who command. To notify all SGM clients that you are uninstalling SGM, use the sgm wall command.

---

You do not need to stop the SGM server; the SGM uninstall program stops the server automatically.

Step 3 To start the uninstall script, enter the following command:

# /opt/CSCOsgm/bin/sgm uninstall

You can also use the sgm uninstall command; see the "SGM Command Reference" appendix in the Cisco Signaling Gateway Manager User Guide.

Step 4 The SGM uninstall program displays the uninstall menu. To uninstall the SGM server, type 1 and press Return.

Step 5 The SGM uninstall program asks you to verify that you want to uninstall the SGM server. When prompted, type y and press Return.

Step 6 When uninstall is complete, the SGM uninstall program displays messages indicating that the packages were deleted successfully.

For example, the following example shows the message received when uninstalling the SGM server:

INFO: The following Cisco SGM

INFO: packages have been successfully deleted from the system: 
CSCOsgm-s CSCOsgm-j2re CSCOsgm-web

Please review /var/tmp/cisco_sgmsvr_uninstall.log for detailed results

Would you like to view the log? [ n ] -> 

•If you do not want to view the log, uninstallation is complete. Press Return.

•If you want to view the log, type y and press Return. The server uninstallation log is displayed, followed by the prompt:

Press Return to continue ->

Press Return.

Step 7 To verify that the SGM server and its associated services are uninstalled, enter the following rpm commands:

# rpm -q CSCOsgm-s

# rpm -q CSCOsgm-j2re

# rpm -q CSCOsgm-web

package "CSCOsgm-s" is not installed

package "CSCOsgm-j2re" is not installed

package "CSCOsgm-web" is not installed

---