Cisco SIP Proxy Server Version 2.0 Installation Guide ......3 CD Installation Guide for the Cisco...

CD Installation Guide for the Cisco SIP Proxy Server (CSPS) on Linux, Version 2.0

The CD Installation Guide for the Cisco SIP Proxy Server on Linux describes how to install the CSPS software on a Pentium-based server running Linux Redhat 7.1. Network engineers, system administrators, or telecommunication engineers should use this guide to learn the steps required to install the CSPS software on a Pentium-based server running Linux.

Note The tasks described are for administration-level, and they require UNIX command and UNIX shell knowledge.

This document contains information on the following:

• Related Documentation, page 1

• Before You Begin, page 2

• Installing the CSPS Software, page 3

• Installing the MySQL Database, page 10

• Upgrading the CSPS, page 16

• Obtaining Documentation, page 28

• Obtaining Technical Assistance, page 29

Related DocumentationCisco SIP Proxy Server Administrator Guide, Version 2.0 should be used in conjunction with this installation guide.

Corporate Headquarters:

Copyright © 2002. Cisco Systems, Inc. All rights reserved.

Cisco Systems, Inc., 170 West Tasman Drive, San Jose, CA 95134-1706 USA

Before You Begin

Before You BeginThis section contains requirements, conditions and knowledge that should be observed before installing the CSPS software on the Linux system.

Platforms and Operating EnvironmentsBefore installing the CSPS, observe the following requirements:

• Platform Requirements:

– PC—Intel Pentium III processor operating with a minimum of 128 MB of RAM and 1 GB of disk space.

– Redhat Linux 7.1

– For IPSec, Linux FreeS/WAN with Redhat Linux (refer to www.freeswan.org for the latest implementation of Linux FreeS/WAN IPSec and its targeted Redhat Linux version).

• To install the CSPS binary distribution, it requires GNU gunzip to decompress the distribution and tar to unpack the distribution.

Pre-installation NotesIn RedHat Linux 7.1, you must select one of the following options to install the RPM.

• Workstation install

• A Custom install with no Package Groups selected

Note Option, Server Install, does not install the required RPM (compat-libstdc++-6.2-2.9.0.9).

To add the required RPM during installation if the option Server Install has been selected, note the following steps:

Step 1 After you selected Server Install, a list of Server Packages to be installed appears. This list contains entries such as Web Server and DNS Server

Click the checkbox, Individual Packages, and click Next.

Step 2 On the next screen, double-click System Environment from the list on the left-side of the screen.

Step 3 Double-click Libraries.

Step 4 In the package window to the right, double-click on the package labeled compat-libstdc++.

A red checkmark appears to indicate that the package will be installed.

Step 5 Click Next and continue with the installation.

2CD Installation Guide for the Cisco SIP Proxy Server (CSPS) on Linux, Version 2.0

78-14815-01

Installing the CSPS Software

If you have already used the Server Install option, do the following to add the correct RPM.

Step 1 Insert the first RedHat 7.1 CD-ROM in the drive

Step 2 As the root user, mount the CD-ROM and add the RPM with the following commands.

mount /dev/cdrom /mnt/cdromrpm -i /mnt/cdrom/RedHat/RPMS/compat-libstdc++-6.2-2.9.0.9.i386.rpm

Preparing for InstallationThis section describes pre-installation procedures as follows.

1. Decide what is to be installed as follows.

– A single proxy or a farm of proxies

– The new CSPS GUI-based provisioning system

– Call forwarding features or local authentication (not RADIUS)

2. Decide how many servers are to be used, and in which server each of the CSPS components is to be installed.

Note There can only be one pserver and one mysql database configured per farm. Multiple sipds and GUIs are allowed.

3. The following information and hardware must be ready.

– If more than one server is used, locate the IP address and/or hostname of each unit. Make sure the system time on all units are synchronized by using utilities such as NTP (Network Time Protocol).

– If MySQL or JRE is to be “ftp” from a DNS resolvable location, DNS is required. If they are available from /tmp or a locally accessible location, DNS is not required.

– Make sure the License Keys are available. A license key can be filed as a soft copy, so you can copy and paste it.

– Find out the domain of the proxy. Default is assumed to be the domain of the server.

See also Chapter 1, “Product Overview” for detail on CSPS components.

Installing the CSPS SoftwareThe CSPS software is available on CD-ROM. This section provides instructions on how to mount and unmount the CSPS CD-ROM and install the CSPS software.

This chapter includes the following information:

• Mounting a Local CD-ROM, page 4

• Installing the CSPS Software, page 4

• Unmounting the CD-ROM Drive, page 15


78-14815-01

http://www.cisco.com/en/US/docs/voice_ip_comm/sip/proxies/2.0/administration/guide/stnover.html


Mounting a Local CD-ROMTo mount the CSPS CD-ROM, insert the CD-ROM into the CD-ROM drive, then perform the following steps:

Step 1 Enter the su command and give the root password at the prompt, or log in as root. The prompt changes to the pound sign (#).

Step 2 If the /mnt/cdrom directory does not already exist, enter the following command:

# mkdir /mnt/cdrom

Step 3 Mount the CD-ROM drive by entering the following command:

# mount -r /dev/cdrom /mnt/cdrom

The CD-ROM can now be accessed under the directory /mnt/cdrom.

If a mount error occurs, refer to the Linux documentation for troubleshooting information.

Caution Do not manually eject a CD-ROM while it is mounted. Properly unmount the CD-ROM as described in the “Unmounting the CD-ROM Drive” section on page 15 before ejecting the CD-ROM.

The CSPS CD-ROM is mounted. To install the CSPS software, see “Installing the CSPS Software” section on page 4.

Installing the CSPS SoftwareTo install the RPM of the CSPS on Linux, use the following steps.

Step 1 Mount the CDROM. See Mounting a Local CD-ROM, page 4.

Step 2 At the system prompt, log in as root, if not in root.

Step 3 If a previous version of CSPS was installed (for example, version 1.0), use the following command to remove it. In the following command, substitute 1.0 with the version number you currently have.

# rpm -e sip-server-1.0-linux

If this fails, attempt the following command:

# rpm -e CSPS

Note Do not use option -u in the command to upgrade the existing version. See “Upgrading the CSPS” section on page 16. If a dependencies error occurs, use the rpm -e --nodeps CSPS command. Be sure these dependencies do not adversely affect any of the other processes before executing this command.

Step 4 To start installation, issue the following command:

# rpm -i /mnt/cdrom/linux/CSPS-2.0-linux.i386.rpm

Step 5 To verify installation, enter the following command:


78-14815-01


# rpm -Vp CSPS-2.0-linux.i386.rpm

This verifies the checksum, file size, permission, modification time, owner and group. Any errors found are displayed.

Step 6 To run CSPS, use the csps_setup script to do the following:

– Create and/or modify all of the required configuration files.

– Modify the system configuration, so CSPS can automatically run after a reboot.

– Additional scripts may be created and additional software may be downloaded, depending on the CSPS configuration

See“Using the csps_setup Installation Script” section on page 5

Note If your hostname exists in the 127.0.0.1 entry in the /etc/hosts directory, it must be removed. Also make sure the /var/tmp directory has open permissions. Use the command chmod 777 /var/tmp to check.

Using the csps_setup Installation ScriptRun the csps_setup installation script on all the servers. The defaults for the options in the script are viable for most conditions. To use the defaults, press Enter when the defaults are displayed. They are enclosed in square brackets, [ ].

It is required to use the csps_setup script for new installations.

Options

The csps_setup installation script contains the following four options in the main menu:

1. Install CSPS—Installs everything except the GUI and JRE. This option adds the first and only farm member along with the GUI-based provisioning system. To install the GUI, use the Install CSPS Provisioning GUI option (fourth option) described below.

2. Install another farm member to an existing CSPS farm—Same as the Install CSPS option, except that it does not include the pserver nor MySQL, since only one of each of these components should exist. This option adds a second farm member to the CSPS configured in the Install CSPS option.

3. Install CSPS Provisioning GUI—Installs the provisioning GUI client only, along with JRE if needed.

Note The above options are used to configure CSPS with the GUI-based provisioning system. If you are not using the provisioning system, use the Custom Configuration option described below.


78-14815-01


4. Custom Configuration—Asks you questions and use your answers to decide what should be installed at a particular server. This option can be used for any new installation, regardless of whether the GUI-based provisioning system is used.

This option asks which of the following three main configurations will be used.

1. GUI based CSPS Provisioning System including Subscriber Features

2. Subscriber Features Only such as subscriber passwords and call forwarding

3. None. Just run as a basic SIP proxy with no subscriber features nor GUI

Note Use the second choice if you are using call forwarding features or local authentication (not RADIUS), but without the GUI based provisioning system. Since call forwarding and local authentication store data into MySQL (if either are used), MySQL must be installed.

Note When you are asked to enter other farm members, press Enter if you are configuring a single proxy system.

Examples of using csps_setup

This example uses the first option: Install CSPS with GUI based provisioning support.

# ./csps_setup+-------------------------------------------------------------------------| Welcome to Cisco SIP Proxy Server, version 2.0 configuration.|| [1]) Install CSPS| with GUI based provisioning support|| 2) Install another farm member into an existing CSPS farm| with GUI based provisioning support|| 3) Install CSPS Provisioning GUI|| 4) Custom configuration|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer:+-------------------------------------------------------------------------| Choose the network interface the servers will use to communicate with| the other farm servers.|| [1]) 172.19.175.110| 2) 1.4.175.110|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer:+-------------------------------------------------------------------------| Please enter the CSPS License Key.|| Q) Quit| ?) Help+-------------------------------------------------------------------------


78-14815-01


Answer: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx+-------------------------------------------------------------------------| Please enter the Proxy Domain.| [ cisco.com ]|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer:+-------------------------------------------------------------------------| Enter the MySQL Server Administrator's root password. This is| the password used to administer the MySQL Server. (The MySQL Server| Administrator's root password is configured separately from the root| password for this machine).|| Please make sure that you remember this password.|+-------------------------------------------------------------------------Password:

Enter the MySQL Server Administrator's password again.

Password:

+-------------------------------------------------------------------------| Enter the MySQL username which the Cisco SIP Proxy Server(s) will use to| access the MySQL server.|| If you are attempting a reinstall of MySQL, you MUST use the existing| user name, or the installation process will fail.|| [ guest ]|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer:+-------------------------------------------------------------------------| Enter the MySQL password that the Cisco SIP Proxy Server(s) will use to| access the MySQL server.|| If you are attempting a reinstall of MySQL, you MUST use the existing| user password, or the installation process will fail.|| [ nobody ]|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer:+-------------------------------------------------------------------------| Choose the location of the MySQL package.|| [1]) FTP download from ftpeng.cisco.com| 2) Local directory to be specified| 3) Already installed on this machine|| Q) Quit| ?) Help+-------------------------------------------------------------------------


78-14815-01


Answer:+-------------------------------------------------------------------------| Are the following settings correct?|| Proxy Domain: "cisco.com"|| IP Address: "172.19.175.110"| MySQL User Name: "guest"| MySQL User Password: "nobody"| MySQL Location: "ftpeng.cisco.com"|| [ Yes ] / No|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer:Created /usr/local/sip/conf/license.confCreated /usr/local/sip/conf/prov/spa.confCreated /usr/local/sip/conf/prov/ps.confCreated /usr/local/sip/conf/prov/lm.confCreated /usr/local/sip/conf/sipd.confInstalling MySQL. This may take a while ... complete.Updated LicenseKey in TempLicense table.Updated LicenseKey in License table.Updated Seeding table.Updated CSPS table in MySQL.Starting pserver: [ OK ]Starting sipd: [ OK ]

+-------------------------------------------------------------------------|| CSPS setup complete.|+-------------------------------------------------------------------------

This example uses the third option: Install CSPS Provisioning GUI.

# ./csps_setup+-------------------------------------------------------------------------| Welcome to Cisco SIP Proxy Server, version 2.0 configuration.|| [1]) Install CSPS| with GUI based provisioning support|| 2) Install another farm member into an existing CSPS farm| with GUI based provisioning support|| 3) Install CSPS Provisioning GUI|| 4) Custom configuration|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: 3+-------------------------------------------------------------------------| Enter the host name of the provisioning server (pserver).|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: localhost


78-14815-01


+-------------------------------------------------------------------------| Choose the location of the Java Runtime Environment package, JRE-1.3.1?|| [1]) FTP download from ftpeng.cisco.com| 2) Local directory to be specified| 3) Already installed on this machine|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer:+-------------------------------------------------------------------------| Are the follow settings correct?||| PServer Host: "localhost"|| JRE-1.3.1 Location: "ftpeng.cisco.com"|| [ Yes ] / No|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer:Created /usr/local/sip/conf/jaas.confCreated /usr/local/sip/bin/sysadmin_csps_provisionCreated /usr/local/sip/bin/sysadmin_csps_licenseDownloading j2re-1_3_1_02-linux-i386-rpm.binFile transfer progress ....Download completeInstalling /tmp/j2re-1_3_1_02-linux-i386-rpm.bin ... complete.Installing ./jre-1.3.1_02.i386.rpm ... complete.

+-------------------------------------------------------------------------|| CSPS setup complete.|+-------------------------------------------------------------------------

Adding, Updating or Removing Farm Members

Under the following conditions, use the second option in the script (Install another farm member to an existing CSPS farm) to prevent multiple pservers and mysql databases from being created.

• Installing a multi-member farm and using the GUI-based provisioning system

• Already used the csps_setup script (option 1) on the first proxy, and installing additional proxies

Since the first proxies configured do not have the data entered for subsequent proxies, use one of the following methods to update the proxies after installation is completed on each server.

• Reboot all the servers. All processes start automatically.

• Restart all processes on each server with the following command:

/usr/local/sip/bin/sip restart

Note Run the servers with either csps permission or root permission. Log ownership prevents CSPS from running the log after root has run the log.


78-14815-01


To remove a farm member, note the following:

• From the main provisioning GUI, update the farm member list in the Farm/Proxies option (in the Farming tab).

• From the licensing GUI, remove the associated license.

Limitations

• For multi-system installations using the GUI based provisioning system, the system with MySQL must be installed first. The system that is used to run the pserver must be installed next, if it is not already installed on the first system.

• If NIS is being run on the systems, it could take a very long time to create a csps user and csps group. It is recommended not to run NIS on the systems.

Installing the MySQL DatabaseThe MySQL database is needed when the CSPS performs any of the following:

• Authorization (using HTTP-Digest or HTTP-Basic)

• Call Forwarding features:

– Call Forward Unconditional

– Call Forward on Busy

– Call Forward on (user) No Answer

– Call Forward on (device) Unavailable

• GUI based provisioning system

It can be installed on either the same or different computer system from the CSPS. During installation, the csps_setup script does the following:

• Install the MySQL client and MySQL server RPMs

• Create the subscriber table and all of the new tables required by the GUI based provisioning system

After a successful installation, use the functionalities of the sysadmin_mysql_user script which can add, remove and modify subscriber records in the MySQL database. However, it is not recommended to use sysadmin_mysql_user script if the GUI based provisioning system is being used.

Using Installation Script

It is recommended to use the csps_setup script for all installations, including installing MySQL on a separate system only. You can also install MySQL by using the install_mysql_db script. This script has been successfully tested on Redhat 7.1 platform.

Step 1 At the system prompt, log in as root.

$ su root

Step 2 Enter the password at the next prompt.

Note If you are not logged in as the root user, the following error message appears.


78-14815-01


+------------------------------------------------------------+| This installation script must run with root permissions. || Please su to root ("su root") and run this script again. |+------------------------------------------------------------+

Step 3 Run the install_mysql_db script from the bin directory of the CSPS.

# /usr/local/sip/bin/install_mysql_db

The following prompt appears.

Continue installation of MySQL? [y/n]

Step 4 Enter Y to continue installation, and N to quit. If you enter Y, the following appears.

Continuing installation...+-------------------------------------------------------------------+| Before continuing subscriber database installation, you will need || to obtain a local copy of the MySQL 3.23. |+-------------------------------------------------------------------+Attempt to ftp MySQL files? [y/n]

Step 5 If your system is connected to the public internet, enter Y to automatically ftp the MySQL RPMs. Otherwise, manually ftp the following RPM files (in MySQL-3.23 directory) from URL ftpeng.cisco.com.

– MySQL-client-3.23.33-1.i386.rpm

– MySQL-3.23.33-1.i386.rpm

– MySQL-shared-3.23.33-1.i386.rpm

If you enter Y, the following screen appears.

+------------------------------------------------------------+| We are now going to prompt you for the remote location || from which to ftp the MySQL file. || || Unless you know otherwise, you should || accept the defaults. || || NOTICE: If you encounter problems during ftp transfer, || check host table, DNS service, network connection, || and status of the target FTP server. |+------------------------------------------------------------+

Step 6 Press Enter to accept the default values. These defaults are valid for most users.

If you do not want the default values, enter a FTP server, MySQL RPM directory, MySQL client RPM (remote) filename, MySQL server RPM (remote) filename and MySQL Shared Library RPM (remote) filename as you are prompted. The following prompts appears.

Enter FTP server: [ftpeng.cisco.com]

Enter MySQL (remote) directory: [mysql]

Enter MySQL client RPM (remote) filename: [MySQL-client-3.23.33-1.i386.rpm]

Enter MySQL server RPM (remote) filename: [MySQL-3.23.33-1.i386.rpm]

Enter MySQL Shared library RPM (remote) filename: [MySQL-shared-3.23.33-1.i386.rpm]


78-14815-01


After five unsuccessful retries, the script assumes that your system is not connected to the public internet. Manually ftp your files as mentioned in step 5.

When ftp is completed, the following screen appears.

+-------------------------------------------------------+| We're now going to prompt you for the local || pathnames at which the MySQL files are located. || || If you have successfully ftp'ed the files to the || local machine, then you can accept the defaults. |+-------------------------------------------------------+

Step 7 As prompted, enter the local pathnames where the MySQL client RPM, server RPM and shared library RPM reside. When the following prompts appear, press Enter to accept the default values. These defaults are valid for most users.

Enter the local pathname of the MySQL Client RPM [/tmp/MySQL-client-3.23.33-1.i386.rpm]:

Using default local pathname: /tmp/MySQL-client-3.23.33-1.i386.rpmFile was found at: /tmp/MySQL-client-3.23.33-1.i386.rpm

Enter the local pathname of the MySQL Server RPM [/tmp/MySQL-3.23.33-1.i386.rpm]:

Using default local pathname: /tmp/MySQL-3.23.33-1.i386.rpmFile was found at: /tmp/MySQL-3.23.33-1.i386.rpm

Enter the local pathname of the MySQL Shared library RPM [/tmp/MySQL-shared-3.23.33-1.i386.rpm]:

During installation, a mysql group and user are added if they do not exist.

Checking for existence of mysql group...id: mysql: No such userAdding group mysql to this machine...

Checking for existence of mysql user.../usr/bin/id: mysql: No such userAdding user mysql to this machine...

The following screen appears.

+--------------------------------------------------------------------+| We're now going to prompt you for the MySQL Server Administrator's || root password. This is the password used to administer the MySQL || Server. (The MySQL Server Administrator's root password is || configured separately from the root password for this machine). || || Please make sure that you remember this password!!! |+--------------------------------------------------------------------+Enter a password for the MySQL Server Administrator:Enter the MySQL Server Administrator's password again (to confirm):

Step 8 Enter the MySQL Administrator’s root password as prompted. This password is not the same as the root user password. The following screen appears.


78-14815-01


+------------------------------------------------------+| We will now prompt you for a username and password || which the Cisco SIP Proxy Server(s) will use to || access this MySQL server. || || Unless you know otherwise, you can || accept the defaults. |+------------------------------------------------------+Enter the MySQL username that the Cisco SIP Proxy Server(s) will useto access the MySQL server: [guest]Enter the MySQL password that the Cisco SIP Proxy Server(s) will useto access the MySQL server: [nobody]

Step 9 As prompted, enter a username and password for the CSPS to access the MySQL server. The default values shown are valid for most users. The following screens appear.

+------------------------------------------------------------------+| We're now going to prompt you for the MySQL database name || which will be used for CSPS. || || Unless you know otherwise, you should accept the defaults. |+------------------------------------------------------------------+Enter MySQL database name: [sip]

...+------------------------------------------------------------------+| We're now going to prompt you for the MySQL name of the || subscriber table in that database which will be used for || subscriber database creation. || || Unless you know otherwise, you should accept the defaults. |+------------------------------------------------------------------+Enter subscriber table name: [subscriber]

Step 10 Enter MySQL database name and subscriber table name as prompted. The default values shown are valid for most users. Message on installation completion appears as follows.

+-------------------------------------------+| Subscriber database installation complete |+-------------------------------------------+

+----------------------------------------------------------------+| If you don't use the provisioning system (i.e. you configure || your proxy settings using the sipd.conf file) you should now || edit sipd.conf of each Cisco SIP Proxy Server, and set the || specified directives as follows: |DB_MySQL OnDB_MySQL_HostName vvs-fencingDB_MySQL_DB sipDB_MySQL_Username guestDB_MySQL_Password nobodyDB_MySQL_Subscriber_Table subscriber+----------------------------------------------------------------+


78-14815-01


Installing and Creating MySQL Database Manually

Note This is not recommended.

Instructions for manually installing the MySQL database and creating the main subscriber table can be found in the README.cisco file. It is recommended to use the installation scripts that also create additional tables for the provisioning system. These additional tables must be created at installation time. Otherwise, the GUI based provisioning system cannot be used, and problems may occur in upgrading to include the GUI based provisioning system in the future.

Testing MySQL Server Installation Manually

To test whether the installation is successful, issue the following commands:

/usr/bin/mysqlshow/usr/bin/mysqlshow -u root mysql/usr/bin/mysqladmin version status proc

Starting MySQL Server Manually

The server is automatically started when the /usr/local/sip/bin/install_mysql_db script is executed. To start the server manually, use the following command:

/etc/rc.d/init.d/mysql start

Note An alternative command to start the server manually is /usr/bin/safe_mysqld &

Stopping MySQL Server Manually

To stop the server manually, use the following command:

/etc/rc.d/init.d/mysql stop

Setting the Password for the MySQL Administrator Manually

The password is automatically set when the/usr/local/sip/bin/install_mysql_db script is executed. It is recommended to add a password for the root user by using the following commands.

bin/mysqladmin -u root password your_passwordbin/mysqladmin reload

Uninstalling MySQL DatabaseThis section describes how to uninstall the MySQL server and MySQL client.

Step 1 At the system prompt, log in as root.

Step 2 At the next prompt, enter the following:

/usr/local/sip/bin/uninstall_mysql_db


78-14815-01

Uninstalling the CSPS

The following prompt appears:

This script will uninstall the MySQL server and MySQL client components.Do you wish to continue? [y/n]

Step 3 Enter Y or N to the question “Do you wish to continue?”. The following prompt appears.

Do you wish to delete the MySQL databases (in /var/lib/mysql)? [y/n]

Step 4 Enter Y or N to the question “Do you wish to delete the MySQL databases?”. The following prompt appears:

Are you sure? (Deleting /var/lib/mysql will remove ALL subscriber database information)[y/n]

Step 5 Enter Y or N to the question “Are you sure?”.

If you enter Y, message on uninstallation completion appears as follows.

Removing /var/lib/mysql...Uninstall operation complete. (/var/lib/mysql was removed)

CIAgent Installation

See Chapter 7, “CIAgent” for installation and operations instructions.

Unmounting the CD-ROM DriveA CD-ROM can only be unmounted if no processes are currently accessing the drive (including having the default directory set to the mounted drive).

To unmount the CD-ROM, perform the following steps.

Step 1 Unmount the CD-ROM drive by entering the following commands as superuser:

# cd /# umount /mnt/cdrom

Step 2 Eject the CD-ROM from the Linux machine by pressing the eject button on the machine.

Step 3 Remove the CD-ROM and store it in a safe place.

Uninstalling the CSPS

Warning Uninstallation completely removes CSPS from a system. If you want to upgrade the system, do not uninstall by using the steps in this section. Use the upgrade instructions in “Upgrading the CSPS” section on page 16.

Step 1 To uninstall a system, login as root.

Step 2 Stop the processes by using the following commands:

/usr/local/sip/bin/sip stop


78-14815-01

http://www.cisco.com/en/US/docs/voice_ip_comm/sip/proxies/2.0/administration/guide/stncia.html

Upgrading the CSPS

Step 3 Remove the following with corresponding commands as follows.

• MySQL database. See “Uninstalling MySQL Database” section on page 14.

bin/uninstall_mysql_db

• Installation package

rpm -e CSPS

• Miscellaneous files

rm -rf /usr/local/sip /etc/init.d/sip /etc/rc3.d/S95sip /etc/rc.d/init.d/sip /etc/rc.d/rc3.d/S95sip

• Backup files

Warning The following command removes all backups of your CSPS data permanently.

rm -rf /var/log/sipd

• JRE

rpm -e jre-1.3.1_02

Note The directory /usr/java/ may still exist. It can be safely removed.

Upgrading the CSPSThis section describes how to upgrade the CSPS in the following conditions:

• Upgrading CSPS 1.2/1.3 to CSPS 2.0

• Adding the GUI Based Provisioning System to CSPS 2.0

• Removing the GUI Based Provisioning System from CSPS 2.0

Note • When upgrading to a farm with the GUI based provisioning system, upgrade the system that runs MySQL first.

• When backing up data into a file, save it into a directory outside of the directory /usr/local/sip.

• When upgrading multi-member farms, restart them all at the end with the /usr/local/sip/bin/sip restart command to ensure the latest sipd.conf changes are retrieved appropriately.

• When using the CSPSConfConvertor, be sure that the Cisco SIP Access Control configuration in the sipd.conf (.keep) does not have a directive, Order Mutual-failure. If this directive exists, manually change it to Order Allow,Deny. This is the only option the provisioning system accepts. Order Mutual-failure and Order Allow,Deny have the same effect and Apache deprecates Order Mutual-failure.


78-14815-01

Upgrading the CSPS

Upgrading from CSPS 1.2/1.3 to CSPS 2.0This section describes the upgrade from CSPS 1.2/1.3 to CSPS 2.0.

Step 1 Back up your current data.

This step may not be necessary in most cases, it is always safer to backup any data before performing the upgrade. See Chapter 5, “Maintaining the Cisco SIP Proxy Server (CSPS)” in the Cisco SIP Proxy Server Administrat or Guide.

a. If you run MySQL, save the data to a flat file with the following commands.

mysqldump -u guest -p --databases sip > <outside_directory/file>

Note If MySQL is not on the same system as CSPS, run the above commands on the system where MySQL is running.

b. If you have registries, export them to a file. Use the sysadmin_csps_regroute tool and make the following selections:

<S> Select registry (default) or routing database<Y> use registry database<M> return to Main menu<X> eXport current database entries to a configuration <outside_directory/file>

c. If you have static routes, export them to a file. Use the sysadmin_csps_regroute tool and make the following selections:

<S> Select registry (default) or routing database<Z> use routing database<M> return to Main menu<X> eXport current database entries to a configuration <outside_directory/file>

d. Stop sipd with the following command:

/usr/local/sip/bin/sipdctl stop

Step 2 Remove the existing CSPS application and install a new one.

To remove the existing CSPS and install the new CSPS RPMs, see “Installing the CSPS Software” section on page 4. Ignore the last step in that section, and use the next step in this section.

The following directories are created when CSPS is removed.

• /var/log/sipd/conf (contains sipd.conf-dist.keep and sipd.conf.keep)

• /var/log/sipd/logs (contains all files that were in /log directory, including registry_db and routing_db)

The following files are copied to the directories listed when the new CSPS is installed.

• /var/log/sipd/conf/sipd.conf.keep to /usr/local/sip/conf/sipd.conf.keep

• /var/log/sipd/conf/sipd.conf-dist.keep to /usr/local/sip/conf/sipd.conf-dist.keep

• /var/log/sipd/logs/registry_db to /usr/local/sip/logs/registry_db

• /var/log/sipd/logs/routing_db to /usr/local/sip/logs/routing_db


78-14815-01

http://www.cisco.com/en/US/docs/voice_ip_comm/sip/proxies/2.0/administration/guide/stnmaint.html

http://www.cisco.com/en/US/docs/voice_ip_comm/sip/proxies/2.0/administration/guide/stnmaint.html

Upgrading the CSPS

Step 3 Log in as root, and complete the installation as follows.

Set up your environment variable:

Using a bash or ksh shell:export LD_LIBRARY_PATH=/usr/local/sip/libexec

Using a csh or tcsh shell:setenv LD_LIBRARY_PATH /usr/local/sip/libexec

Step 4 Select your configuration (A-F) from the following list.

Note For all installations which include provisioning, it is assumed you will place your mysql database and provisioning server on the same system.

A. CSPS 1.2/1.3, with MySQL --> CSPS 2.0, with MySQL, but no provisioning GUI

a. Convert the MySQL database on the system running MySQL with the following command:

/usr/local/sip/bin/convert_mysql_db_v2

Enter the location of the sipd.conf.keep file. Usually, it is in /usr/local/sip/conf/sipd.conf.keep

b. Perform B. CSPS 1.2/1.3, without MySQL --> CSPS 2.0, without MySQL nor a provisioning GUI, as shown below.

B. CSPS 1.2/1.3, without MySQL --> CSPS 2.0, without MySQL nor a provisioning GUI

Note Do the following on all systems.

a. Configure the new directives in /usr/local/sip/conf/sipd.conf

For detail on new directives in newly installed sipd.conf-dist file, use the following command:

diff sipd.conf-dist sipd.conf-dist.keep

b. Propagate the changes from /usr/local/sip/conf/sipd.conf.keep into /usr/local/sip/conf/sipd.conf.

To find which changes have been made to the old sipd.conf, use the following command:

diff sipd.conf-dist.keep sipd.conf.keep

Make sure the new user and group are in the new sipd.conf file. Use a text editor to change the user and group to csps in the new sipd.conf file as follows (for example, vi /usr/local/sip/conf/sipd.conf.keep).

User cspsGroup csps

Note Make sure the Cisco_Registry_Farm_Members and Cisco_Routing_Farm_Members directives do not include the IP or hostname of this current system.

Save the file.

c. Create a license.conf file in the /usr/local/sip/conf directory with your license key. The license.conf file format is as follows.

LicenseKey <license key>LicenseDebug Off


78-14815-01

Upgrading the CSPS

d. Create the sip script with the following commands:

cp /usr/local/sip/bin/sip-dist /usr/local/sip/bin/sip chown csps:csps /usr/local/sip/bin/sip chmod 770 /usr/local/sip/bin/sip

e. Start CSPS with the following command:

/usr/local/sip/bin/sip start

f. Add the following links so CSPS automatically starts upon a reboot.

ln -s /usr/local/sip/bin/sip /etc/rc.d/rc3.d/S99siprm /etc/rc.d/rc3.d/S95sipd

C. CSPS 1.2/1.3, without MySQL --> CSPS 2.0, with the provisioning GUI, with MySQL sharing a machine with CSPS

Note If this configuration is used, you are hosting the mysql database on the same system as one of your farm members.

a. On the system that will host mysql and one of the farm members, use the following command to install CSPS:

/usr/local/sip/bin/csps_setup

The following display appears.

- Welcome to Cisco SIP Proxy Server, version 2.0 configuration. -> [1]) Install CSPS

- Please enter the CSPS License Key. -> enter the key

- Please enter the Proxy Domain -> Enter what you have against ProxyDomain in /usr/local/sip/conf/sipd.conf.keep

- Enter the MySQL Server Administrator's root password -> enter your password

- Enter the MySQL Server Administrator's password again. -> enter your password

- Enter the MySQL username which the Cisco SIP Proxy Server(s) will use to access the MySQL server. -> default is "guest"

- Enter the MySQL password that the Cisco SIP Proxy Server(s) will use to access the MySQL server. -> default is "nobody"

- Choose the location of the MySQL package. -> select 1 (or 2 if you have downloaded mysql previously)

- Are the follow settings correct? -> verify and select yes


78-14815-01

Upgrading the CSPS

b. Make sure the new user and group are in the old sipd.conf. Use a text editor to change the user and group to csps in the old sipd.conf file as follows (for example, vi /usr/local/sip/conf/sipd.conf.keep).

User cspsGroup csps

Note Make sure the Cisco_Registry_Farm_Members and Cisco_Routing_Farm_Members directives includes the IP or hostname of this current system.

Save the file.

c. Push the old sipd.conf values into mysql with the following command:

/usr/local/sip/bin/CSPSConfConvertor -f /usr/local/sip/conf/sipd.conf.keep -n (dbname) -h (sqlhost) -u (sqluser) -p(sqlpasswd)

Note Remember to enter the system from Step a. for sqlhost.

d. Push the static routes and static registries to mysql with the following command:

/usr/local/sip/bin/sysadmin_csps_regroute -P -p /usr/local/sip/conf/sipd.conf.keep

e. On each of the other farm members, add a farm member by running the following command:



- Welcome to Cisco SIP Proxy Server, version 2.0 configuration. -> 2) Install another farm member into an existing CSPS farm with GUI based provisioning support

- Please enter the CSPS License Key -> enter the key

- Please enter the Proxy Domain -> Enter what you have against ProxyDomain in /usr/local/sip/conf/sipd.conf.keep

- Enter the host name of the provisioning server (pserver). -> Enter host name of machine from Step 1 above



- Enter the hostname of the machine the MySQL database will be running on. -> Machine where mySQL is running

- Please choose the location of the MySQL package? -> select 1 (or 2 if you have downloaded mysql previously)



78-14815-01

Upgrading the CSPS

D. CSPS 1.2/1.3, without MySQL --> CSPS 2.0, with the provisioning GUI, with MySQL and CSPS on different machines

Note If this configuration is used, you are hosting mysql on a system separate from any of your farm members. You will install the provisioning server on the same system as mysql.

a. On the system that will host mysql, install mysql with the following command:



- Welcome to Cisco SIP Proxy Server, version 2.0 configuration. -> 4) Custom configuration

- Install the SIP proxy server (sipd) on this machine? -> No

- Which provisioning system are you going to use? -> 1) GUI based CSPS Provisioning System

- Install the provisioning server (pserver) on this machine? -> Yes

- Install the provisioning database (mysql) on this machine? -> Yes

- Install the provisioning gui on this machine? -> Yes or No, depending on where you want to run the GUI.

- Is the following configuration correct? -> verify and select yes




- Choose the location of the MySQL package. -> select 1 (or 2 if you have downloaded mysql previously)



78-14815-01

Upgrading the CSPS


User cspsGroup csps


Save the file.

c. Push the old sipd.conf values into mysql. On the system that hosts one of the farm members, run the following command:





e. Install the farm members. On each of the other farm members, run the following command to add a farm member:



- Welcome to Cisco SIP Proxy Server, version 2.0 configuration. -> 2) Install another farm member into an existing CSPS farm with GUI based provisioning support - Please enter the CSPS License Key -> enter the key.

- Enter the host name of the provisioning server (pserver). -> enter the name of the machine from Step 1 above



- Enter the hostname of the machine the MySQL database will be running on. -> enter host name of machine from Step 1 above

- Please choose the location of the MySQL package? -> select 1 (or 2 if you have downloaded mysql previously)



78-14815-01

Upgrading the CSPS

E. CSPS 1.2/1.3, with MySQL --> CSPS 2.0, with the provisioning GUI, with MySQL sharing a machine with CSPS

Note If this configuration is used, you are hosting the mysql database on the same system as one of the farm members.

a. Update the mysql database with the following command:

/usr/local/sip/bin/convert_mysql_db_v2



User cspsGroup csps


Save the file.






e. Setup CSPS on the same system as mysql. Do not need to re-install mysql. Use the following command:

/usr/local/sip/bin/csps_setup:



- Install the SIP proxy server (sipd) on this machine? -> Yes

- Which provisioning system are you going to use? -> 1) CSPS Provisioning System


- Install the provisioning database (mysql) on this machine? -> No (your database has been upgraded and installed already)



78-14815-01

Upgrading the CSPS

- Is the follow configuration correct? -> verify and select yes


- Please enter the Proxy Domain. -> Enter what you have against ProxyDomain in /usr/local/sip/conf/sipd.conf.keep



- Enter the hostname of the machine the MySQL database will be running on. -> the name of this machine

- Choose the location of the Java Runtime Environment package, JRE-1.3.1? -> FTP download from ftpeng.cisco.com (will only be asked if the Gui is being installed)


f. Setup the remaining farm members. They should already have the msql client installed. On each of the farm members, add a farm member with the following command and the corresponding display follows.








- Enter the hostname of the machine the MySQL database will be running on. -> enter host name of machine from Step 1 above

- Please choose the location of the MySQL package? -> select 3



78-14815-01

Upgrading the CSPS

F. CSPS 1.2/1.3, with MySQL --> CSPS 2.0, with the provisioning GUI, with MySQL and CSPS on different machines

Note If this configuration is used, you are hosting mysql on a system separate from any of the farm members. You will install the provisioning server on the same system as mysql.

a. Update the mysql database by copying the files (/usr/local/sip/bin/convert_mysql_db_v2 and/usr/local/sip/conf/sipd.conf.keep) to a location accessible from the system where MySQL is running.

Use the following command:

convert_mysql_db_v2



User cspsGroup csps

Note Make sure the Cisco_Registry_Farm_Members and Cisco_Routing_Farm_Members directives includes the IP or hostname of this current machine.

Save the file.






e. Install the provisioning server on the system that will host mysql by using the following command:




- Install the SIP proxy server (sipd) on this machine? -> No

- Which provisioning system are you going to use? -> 1) GUI based CSPS Provisioning System



78-14815-01

Upgrading the CSPS

- Install the provisioning database (mysql) on this machine? -> No


- Is the following configuration correct? -> verify and select yes





f. Setup the remaining farm members. They should already have the msql client installed. On each of the farm members, add a farm member with the following command:








- Enter the hostname of the machine the MySQL database will be running on. -> enter host name of machine Step 5 above

- Please choose the location of the MySQL package? -> select 3



78-14815-01

Upgrading the CSPS

Adding the GUI Based Provisioning System to CSPS 2.0This section describes the upgrade from CSPS 2.0 (without provisioning) to CSPS 2.0 (with provisioning).

The instructions in “Upgrading from CSPS 1.2/1.3 to CSPS 2.0” section on page 17 can be used to add the GUI Based Provisioning System to an existing CSPS 2.0. The following steps can be omitted.

• Remove the existing CSPS application and install a new one.

• Set the user/group to csps in the sipd.conf(.keep)

• Run convert_mysql_db_v2

Removing the GUI Based Provisioning System from CSPS 2.0This section describes removing the CSPS 2.0 GUI based provisioning system.

Step 1 Stop CSPS by using the following commands:

/usr/local/sip/bin/sip stop

Step 2 Rerun the csps_setup script by using the following command:


a. Choose option 4, Custom Configuration

b. Enter Y or press Enter for the following question:

Install the SIP proxy server (sipd) on this machine?

c. Select option 3, None, for the following question:

Which provisioning system are you going to use?

d. Enter Y or press Enter for the following question:

Is the following configuration correct?

e. Enter your CSPS License Key

f. Enter your proxy domain

g. Enter the addresses of the other farm members, and separate each entry with a comma.

For example, for two other farm members at ip addresses 192.168.1.10 and 192.168.1.11, enter 192.168.1.10, 192.168.1.11. If no farm members are needed, press Enter.

h. Review the displayed configuration information. If they are correct, enter Y or press Enter for the following question:

Are the following settings correct?

Entering N for this question allows you to re-enter the license key, proxy domain and addresses of other farm members.

Once completed, this csps_setup script creates an updated system configuration, and automatically starts the system.

Step 3 Uninstall the JRE with the following command:


78-14815-01

Obtaining Documentation

Note Before uninstalling the JRE, make sure no other applications require it. It is safe to leave the JRE installed.

rpm -e jre-1.3.1_02

Step 4 Restart the proxy without the provisioning system related processes by using the following command:

/usr/local/sip/bin/sip start

Obtaining DocumentationThe following sections explain how to obtain documentation from Cisco Systems.

World Wide WebYou can access the most current Cisco documentation on the World Wide Web at the following URL:

http://www.cisco.com

Translated documentation is available at the following URL:

http://www.cisco.com/public/countries_languages.shtml

Documentation CD-ROMCisco documentation and additional literature are available in a Cisco Documentation CD-ROM package, which is shipped with your product. The Documentation CD-ROM is updated monthly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual subscription.

Ordering DocumentationCisco documentation is available in the following ways:

• Registered Cisco Direct Customers can order Cisco product documentation from the Networking Products MarketPlace:

http://www.cisco.com/cgi-bin/order/order_root.pl

• Registered Cisco.com users can order the Documentation CD-ROM through the online Subscription Store:

http://www.cisco.com/go/subscription

• Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco corporate headquarters (California, USA) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).


78-14815-01


http://www.cisco.com/public/countries_languages.shtml

http://www.cisco.com/cgi-bin/order/order_root.pl

http://www.cisco.com/go/subscription

Obtaining Technical Assistance

Documentation FeedbackIf you are reading Cisco product documentation on Cisco.com, you can submit technical comments electronically. Click Leave Feedback at the bottom of the Cisco Documentation home page. After you complete the form, print it out and fax it to Cisco at 408 527-0730.

You can e-mail your comments to [email protected].

To submit your comments by mail, use the response card behind the front cover of your document, or write to the following address:

Cisco SystemsAttn: Document Resource Connection170 West Tasman DriveSan Jose, CA 95134-9883

We appreciate your comments.

Obtaining Technical AssistanceCisco provides Cisco.com as a starting point for all technical assistance. Customers and partners can obtain documentation, troubleshooting tips, and sample configurations from online tools by using the Cisco Technical Assistance Center (TAC) Web Site. Cisco.com registered users have complete access to the technical support resources on the Cisco TAC Web Site.

Cisco.comCisco.com is the foundation of a suite of interactive, networked services that provides immediate, open access to Cisco information, networking solutions, services, programs, and resources at any time, from anywhere in the world.

Cisco.com is a highly integrated Internet application and a powerful, easy-to-use tool that provides a broad range of features and services to help you to

• Streamline business processes and improve productivity

• Resolve technical issues with online support

• Download and test software packages

• Order Cisco learning materials and merchandise

• Register for online skill assessment, training, and certification programs

You can self-register on Cisco.com to obtain customized information and service. To access Cisco.com, go to the following URL:


Technical Assistance CenterThe Cisco TAC is available to all customers who need technical assistance with a Cisco product, technology, or solution. Two types of support are available through the Cisco TAC: the Cisco TAC Web Site and the Cisco TAC Escalation Center.


78-14815-01



Inquiries to Cisco TAC are categorized according to the urgency of the issue:

• Priority level 4 (P4)—You need information or assistance concerning Cisco product capabilities, product installation, or basic product configuration.

• Priority level 3 (P3)—Your network performance is degraded. Network functionality is noticeably impaired, but most business operations continue.

• Priority level 2 (P2)—Your production network is severely degraded, affecting significant aspects of business operations. No workaround is available.

• Priority level 1 (P1)—Your production network is down, and a critical impact to business operations will occur if service is not restored quickly. No workaround is available.

Which Cisco TAC resource you choose is based on the priority of the problem and the conditions of service contracts, when applicable.

Cisco TAC Web Site

The Cisco TAC Web Site allows you to resolve P3 and P4 issues yourself, saving both cost and time. The site provides around-the-clock access to online tools, knowledge bases, and software. To access the Cisco TAC Web Site, go to the following URL:

http://www.cisco.com/tac

All customers, partners, and resellers who have a valid Cisco services contract have complete access to the technical support resources on the Cisco TAC Web Site. The Cisco TAC Web Site requires a Cisco.com login ID and password. If you have a valid service contract but do not have a login ID or password, go to the following URL to register:

http://www.cisco.com/register/

If you cannot resolve your technical issues by using the Cisco TAC Web Site, and you are a Cisco.com registered user, you can open a case online by using the TAC Case Open tool at the following URL:

http://www.cisco.com/tac/caseopen

If you have Internet access, it is recommended that you open P3 and P4 cases through the Cisco TAC Web Site.

Cisco TAC Escalation Center

The Cisco TAC Escalation Center addresses issues that are classified as priority level 1 or priority level 2; these classifications are assigned when severe network degradation significantly impacts business operations. When you contact the TAC Escalation Center with a P1 or P2 problem, a Cisco TAC engineer will automatically open a case.

To obtain a directory of toll-free Cisco TAC telephone numbers for your country, go to the following URL:

http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml

Before calling, please check with your network operations center to determine the level of Cisco support services to which your company is entitled; for example, SMARTnet, SMARTnet Onsite, or Network Supported Accounts (NSA). In addition, please have available your service agreement number and your product serial number.


78-14815-01

http://www.cisco.com/tac

http://www.cisco.com/register/

http://www.cisco.com/tac/caseopen

http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml


This document is to be used in conjunction with the documents listed in the “Related Documentation” section.

Copyright © 2002, Cisco Systems, Inc.All rights reserved.

CCVP, the Cisco logo, and Welcome to the Human Network are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn is a service mark of Cisco Systems, Inc.; and Access Registrar, Aironet, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, iQuick Study, LightStream, Linksys, MeetingPlace, MGX, Networkers, Networking Academy, Network Registrar, PIX, ProConnect, ScriptShare, SMARTnet, StackWise, The Fastest Way to Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.

All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0711R)


78-14815-01



78-14815-01

Date post:	07-Apr-2020
Category:	Documents
Upload:	others
View:	16 times
Download:	0 times

Cisco SIP Proxy Server Version 2.0 Installation Guide ......3 CD Installation Guide for the Cisco...

Documents