cisco sip proxy server installation guide version 2 · cisco sip proxy server installation guide...

70
1 Cisco SIP Proxy Server Installation Guide 78-15951-01 Cisco SIP Proxy Server Installation Guide Version 2.1 This guide describes how to install Cisco SIP proxy server (Cisco SPS) software on a Linux or Solaris platform and how to do preliminary configuration tasks. Network engineers, telecommunication engineers, and system administrators with administrator privileges and familiarity with UNIX commands and shells are the primary users of this guide. Contents Document Contents This document contains the following sections: Prerequisites, page 2 Restrictions, page 6 Information About the Cisco SIP Proxy Server, page 7 How to Install a New System, page 12 How to Modify or Upgrade an Existing System, page 18 How to Uninstall System Components, page 37 How to Mount and Unmount a CD-ROM Drive and File System, page 40 Additional References, page 65 Product CD Contents The Cisco SPS CD contains the following: Conversion scripts GUI-installer executables (Linux, Solaris, and Windows versions) Cisco SPS-XML interface information—Describes the HTTP server/client interface that carries and parses XML data Linux RPM Package Manager (rpm) software

Upload: others

Post on 07-Jun-2020

31 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1

This guide describes how to install Cisco SIP proxy server (Cisco SPS) software on a Linux or Solaris platform and how to do preliminary configuration tasks.

Network engineers, telecommunication engineers, and system administrators with administrator privileges and familiarity with UNIX commands and shells are the primary users of this guide.

Contents

Document ContentsThis document contains the following sections:

• Prerequisites, page 2

• Restrictions, page 6

• Information About the Cisco SIP Proxy Server, page 7

• How to Install a New System, page 12

• How to Modify or Upgrade an Existing System, page 18

• How to Uninstall System Components, page 37

• How to Mount and Unmount a CD-ROM Drive and File System, page 40

• Additional References, page 65

Product CD ContentsThe Cisco SPS CD contains the following:

• Conversion scripts

• GUI-installer executables (Linux, Solaris, and Windows versions)

• Cisco SPS-XML interface information—Describes the HTTP server/client interface that carries and parses XML data

• Linux RPM Package Manager (rpm) software

1Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 2: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Prerequisites

• Solaris pkg software

• Cisco SIP Proxy Server Administrator Guide—Describes how to configure, monitor, maintain, and troubleshoot Cisco SPS and the MySQL databases

• Cisco SIP Proxy Server Installation Guide—Describes how to install Cisco SPS and the MySQL databases

• Release Notes for the Cisco SIP Proxy Server—Presents system and memory requirements; hardware, software, and firmware release information; new and changed system information; installation notes; limitations and restrictions; open and resolved caveats; troubleshooting information; and service and support information. Offers configuration tips.

Note You can also obtain the guides and release notes, including any updates, at http://www.cisco.com/univercd/cc/td/doc/product/voice/sipproxy/index.htm or http://www.cisco.com/en/US/products/sw/voicesw/ps2157/index.html.

Prerequisites

Hardware and SoftwareBefore installing and configuring Cisco SPS, you must have the appropriate Linux or Solaris platforms installed. For a list of Cisco-supported platforms, refer to the Cisco SIP Proxy Server Release Note at http://www.cisco.com/univercd/cc/td/doc/product/voice/sipproxy/index.htm.

Note If you plan to upgrade to a more recent Cisco SPS and must upgrade your operating system to do so, store your Cisco SPS backup data on an external machine beforehand.

Linux

A Linux platform requires the following:

• Intel Pentium III processor operating with at least 512 MB of RAM and 40 GB of disk space, with the Cisco SPS directories partitioned as follows:

– /usr: with at least 20G

– /tmp: with at least 1G

– swap: with at least 1G

– /var: with at least 10G

2Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 3: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Prerequisites

• Red Hat Linux 7.3 operating system

Note During Red Hat installation, choose Custom Installation > Install Everything. (It is important that you choose this option; the Workstation option does not install all required packages.) At the prompt for a firewall, choose None.

After installation, log in as root and disable IP-chains and IP-tables daemons:

# chkconfig ipchains off ; service ipchains stop

# chkconfig iptables off ; service iptables stop

Note The IBM x335 series server requires a kernel of 2.4.18-27.7 or higher. Default RedHat 7.3 kernels cause kernel panics.

Upgrade to kernel 2.4.18-27 (extn is the extension that you see when you use the uname -a command):

# rpm -Fvh i386/modutils-2.4.18-3.7x.i386.rpm

# rpm -Fvh i686/kernel-<2.4.18-27.7extn>x.i686.rpm

Then reboot.

• For IPSec encryption, Linux FreeS/WAN with Red Hat Linux (download the latest implementation from the Linux FreeS/WAN website at http://www.freeswan.org/)

• For binary distribution, the following Linux packages (included in the All option mentioned above):

– GNU gunzip—Decompression utility

– GNU tar—Unpack utility

Solaris

A Solaris platform requires the following:

• Sun Sparc or UltraSparc server-class workstation with at least 512 MB of RAM and 40 GB of disk space, with the Cisco SPS directories partitioned as follows:

– /opt: with at least 20G

– /tmp: with at least 1G

– swap: with at least 1G

– /var: with at least 10G

• Sun Solaris 2.8 Operating Environment, version 10/01 or 2/02

Note During Solaris installation, choose Custom and select everything except OEM and SNMP.

Note The Sun Netra 20 server requires version 2/02.

In addition, install SUNWbash—GNU Bourne-Again shell (bash).

3Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 4: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Prerequisites

The following should have been installed as part of operating-system installation. If they were not, add them manually:

– SUNWgzip—GNU Zip (gzip) compression utility

– SUNWzlib—Zip compression library

– SUNWzlibS

– SUNWzlibx

– SUNWscpu

– whoami

• For IPSec encryption, supplemental encryption software as required (for details about the CD and free software downloads, go to the Solaris Data Encryption website at http://wwws.sun.com/software/solaris/encryption/)

• For ENUM: Solaris patch 108827-25 to avoid memory leaks

Note For information on installing the Sun Solaris operating system and patches, refer to the Sun Microsystems website or to the first chapters of the Cisco Media Gateway Controller Software Release 9 Installation and Configuration Guide, at http://www.cisco.com/univercd/cc/td/doc/product/access/sc/rel9/swinstl/.

GUI-Based Provisioning System

You configure your Cisco SPS system by modifying values in the SIP directives (sipd.conf) file, as described in the Cisco SIP Proxy Server Administrator Guide. Unless your situation is highly unusual, you should use the GUI-based provisioning system rather than manual means to configure your Cisco SPS. The provisioning system requires the following:

• Microsoft Windows 2000, Red Hat Linux 7.3, or Sun Solaris 2.8

• Java Runtime Environment 1.4.1 (provided automatically by the GUI installer)

• The provisioning client for proxy server

Note The Sun Netra server lacks a graphics adapter and therefore does not support the GUI-based provisioning system.

Ports

Your Cisco SPS system runs from the following default ports:

• Port 5060—Most Cisco SPS activities, including UDP and TCP traffic

• Port 5061—Secure Transport Layer Security (TLS) traffic

• Port 26005—Provisioning server

• Port 26013—Client

• Ephemeral port—For UDP traffic, Cisco SPS responds from a port other than 5060. Normal flow is therefore to receive a request on port 5060 and return a response on a different port.

4Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 5: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Prerequisites

LicenseWhen you purchase a new Cisco SPS system or a conversion or extension that requires a new license key, you receive a product-authorization key (PAK) on either (for new software) the CD case or (for conversions or extensions) a claim certificate.

When you are ready to install the software and begin your evaluation, go to http://www.cisco.com/go/license/public and follow the instructions to register your purchase.

You receive a new license key and installation instructions in a return e-mail.

When you have the license key, you can proceed with installation and setup. You are prompted to enter the license key when you run the SPS setup (sps_setup) script (see the “Setting Up Servers and MySQL Databases in a New System” section on page 13).

Note A new license key is not needed for minor upgrades, and a PAK is not provided. Retain and continue to use the license key provided with your previous purchase.

System Permissions, Strategy, and Functionality

Permissions and Knowledge

You must have the following:

• Administrator privileges

• Familiarity with UNIX commands and shells

Architecture Strategy

You must have determined which one of the following proxy-server architectures to implement:

• One standalone server

• A farm of two servers with no single point of failure for call processing (recommended for any live network where high availability is required)

Configuration Strategy

You must have determined which one of the following strategies to use to configure SIP directives:

• GUI-based provisioning system, also called the provisioning GUI (recommended)

• Manual configuration

Administration TasksYou must have the following information available:

• IP address or hostname (or both) of each proxy server

• License keys, in a form that you can copy and paste

• Domain of the proxy; the domain of the proxy running on a server is, by default, the same as the domain of the server, although you can set the domain of the proxy to something else

5Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 6: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Restrictions

You must have done the following:

• Synchronized the system time on all proxy servers with a utility such as NTP (Network Time Protocol)

• Ensured that each proxy server can resolve its own IP address and those of the other servers

• Removed your hostname from the 127.0.0.1 entry in the /etc/hosts file

Note Some Linux installations put your hostname in the /etc/hosts file by default. This causes the server to become confused about its IP address. If the file has the server hostname in the 127.0.0.1 entry, the server uses 127.0.0.1 as its IP address instead of using its real IP address. However, 127.0.0.1 is the loopback address and should not be used as the server IP address. To avoid this problem, you must remove your hostname from the 127.0.0.1 entry in the /etc/hosts file.

• Ensured that the /var/tmp directory has open permissions by using the chmod 777 /var/tmp command

• (For TLS) Obtained TLS certificates in one of the following ways:

– Create your own certificates using OpenSSL tools (in which case you act as your own certification authority). For more information, go to the OpenSSL website at http://www.openssl.org/.

– Request certificates from well-known (signing) certification authorities. Obtain the corresponding private key in unencrypted form, and certificates of all trusted certification authorities.

Note A certificate should be clearly able to verify the authenticity of the proxy server by using X509 extension SubjAltName. It should verify ProxyDomain,ServerName, and IP address of the proxy as appropriate.

RestrictionsHardware and Software

Members of a proxy-server farm may run on different hardware. However, they must run the same operating system (mixed Linux/Solaris farms are not supported) and the same version of the Cisco SPS software.

Time Synchronization

Members of a proxy-server farm must be time-synchronized to a common clock.

Installation

For multisystem installations using the GUI-based provisioning system, it is easiest and highly preferable for you to install the proxy server that runs MySQL on the same box that runs the provisioning server.

6Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 7: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Information About the Cisco SIP Proxy Server

Network Management

Do not run Network Information System (NIS)—a network-lookup service for managing a network of computers—on the Cisco SPS systems. Doing so can cause long delays when you add a new user or user group. If you do run NIS, be sure to follow instructions to stop it before doing certain configuration tasks.

Permissions

You must run the proxy servers with either csps (default account ID) or root permission. Log ownership prevents csps from running a log after root has run the log.

Information About the Cisco SIP Proxy ServerTo install Cisco SPS, you must understand the following concepts:

• Cisco SPS Basics, page 7

• Multiserver and Single-Server Architectures, page 8

• Cisco SPS Licence, page 9

• IP Security, page 9

• TLS Support, page 9

• UNIX Root Directory, page 10

• MIBs and CIAgent, page 11

Cisco SPS BasicsThe Cisco SPS sits in the core of a SIP network and routes calls among other proxy servers, voice gateways, IP endpoints (such as IP phones), and application servers.

The main components in a Cisco SPS system are the following:

• Proxy server (sipd)—Assumes primary responsibility for call routing in a VoIP network. Cisco SPS supports two servers in a proxy-server farm.

• MySQL database—Stores and accesses provisioning-system and subscriber-feature data. Cisco SPS supports up to two replicated and synchronized databases, each of which typically contains multiple tables. The database is needed when the proxy server performs any of the following:

– Authentication (using HTTP-Digest or HTTP-Basic)

– Call forwarding of any of the following types: call forward unconditional, call forward on busy, call forward on (user) no answer, or call forward on (device) unavailable

– GUI-based provisioning

The database that contains Cisco SPS information is called sip. Within this database are tables for Cisco SPS as well as for the provisioning server.

• GUI-based provisioning system—Retrieves, displays, and facilitates editing or configuration and provisioning of system information. Components include the following:

– Provisioning server (pserver)

– SIP provisioning agent (spa)

– License manager (licenseMgr)

– MySQL database with configuration-specific tables

7Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 8: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Information About the Cisco SIP Proxy Server

– Provisioning GUI

– Licensing GUI

Note Although the GUI-based provisioning system contains these multiple components, of which the provisioning GUI is only one, the system is sometimes referred to as simply the provisioning GUI or occasionally just the GUI.

Multiserver and Single-Server ArchitecturesCisco SPS is designed for deployment in proxy-server farms. A server farm is a group of servers that share database information and provide both redundancy and high availability. In a server farm, multiple physical servers act as one virtual server. Updates to a member are replicated across every other member of the farm. During replication, all members are resynchronized.

A Cisco SPS proxy-server farm can contain up to two servers.

Two configurations are referenced throughout this guide:

• Multiserver architecture. Figure 1 shows two proxy servers in a server farm. Use this architecture for any live network where high availability (no single point of failure for call processing) is required.

• Single-server architecture. Figure 2 shows one standalone proxy server. Use this architecture for initial testing where high availability is not required.

Figure 1 Multiserver Architecture

Figure 2 Single-Server Architecture

1 Primary SIP proxy serverContains SIP proxy, MySQL, Pserver

2 Secondary SIP proxy serverContains SIP proxy, MySQL

3 GUI-based provisioning system

IP

IP

8876

8

1

2

3

IP

IP

1 Standalone SIP proxy serverContains SIP proxy, MySQL, Pserver

2 GUI-based provisioning system

IP

8876

9

IP 21

IP

8Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 9: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Information About the Cisco SIP Proxy Server

Cisco SPS LicenceCisco SPS licenses are either evaluation or permanent.

Your license is delivered to you in the form of a license key. A license key is a sequence of text characters that the Cisco SPS must read and validate at startup before it can run. The Cisco SPS looks for the license key in the license (license.conf) file that resides in one of the following directories:

• Linux: /usr/local/sip/conf

• Solaris: /opt/sip/conf

The file format is as follows:

LicenseKey xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxLicenseDebug Off

Contents

The license key specifies the following:

• Whether this is an evaluation license or a permanent license. An evaluation license has an expiration date. A permanent license has no expiration date.

• The major release supported by the license. Different minor releases of the same major release use the same licence key. Each major release uses a different license key.

• Expiration date, if you have an evaluation license. The date is calculated from when the license key is generated. You cannot start or restart the Cisco SPS after the expiration date, although you can gracefully restart it. A warning appears when you are within seven days of expiration. The time to expiration is logged only when the Cisco SPS is started, restarted, or gracefully restarted.

Procedures

You add your license key as follows:

• Upon system setup, by running the SPS setup (sps_setup) script. The script prompts you for the license key and automatically updates the license (license.conf) file.

• Upon replacement of an evaluation key with a permanent key, in either of the following ways:

– By manually entering the key into the default license (license.conf) file

– By accessing the GUI-based license window

IP SecurityIP security (IPSec) provides security for transmission of sensitive information over unprotected networks such as the Internet. With IPSec, data can be transmitted across a public network without fear of observation, modification, or spoofing. Its use is optional.

TLS SupportTransport Layer Security is an IETF protocol that replaces Secure Socket Layer (SSL) encryption technology to provide secure transactions such as transmission of credit-card numbers for e-commerce. Its use is optional.

9Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 10: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Information About the Cisco SIP Proxy Server

Cisco SPS does not act as a certification authority, but requires proper X.509 certificates and keys to be installed at appropriate locations. From the Cisco SPS point of view, it does not matter if the certificate is from a well-known authority or is self signed by the user. The proxy server needs only to have its certificate, key, and the root certificates installed as part of configuration.

Cisco SPS does not distribute certificates during registration. Rather, you must manage and distribute certificates. You are free to act as certification authority and sign or distribute certificates to your clients, in which case you need to install your self-signed root certificate in the proxy’s configuration.

UNIX Root DirectoryThe root directory from which you access and administer Cisco SPS is as follows:

• Linux: /usr/local/sip

• Solaris: /opt/sip

This is the directory that is identified by the ServerRoot directive in the SIP directives (sipd.conf) file. This directory is referred to generically in command output as <server_root>. It is set automatically and should not be changed.

Within this directory are a number of files and scripts, some of which you use directly and some of which you do not. The bin directory, in particular, contains a large number of files (see Table 1). For examples of script outputs, see the “Script Examples” section on page 42.

Table 1 Contents of the <server_root>/bin Directory

File or Script Purpose User-Accessible?

sps_setup Script that installs Cisco SPS Yes

install_mysql_db Script that is used by sps_setup No

uninstall_mysql_db Script that uninstalls a MySQL database Yes

alter_dump_2.0.shconvert_mysql_dbconvert_mysql_db_v2CSPSConfConvertorupdate_2.1.sh

Scripts that upgrade a Cisco SPS Yes

sipsip-pserver-dist

Scripts that are generated by sps_setup Yes

lmctlpserverctlsipdctlsip-distspactl

Controls individual processes No

licenseMgrpserversipdSip_Servicesspa

Executables, run by scripts No

mysql_sync_check.sh Script that checks whether two MySQL databases are synchronized.

Yes

10Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 11: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Information About the Cisco SIP Proxy Server

Accounts and PasswordsYou will use the following default account IDs and passwords (Table 2).

MIBs and CIAgentA management information base (MIB) is the database of network-management information that is used and maintained by a network-management protocol such as SNMP. You can retrieve and set the value of a MIB object, usually through a GUI network-management system.

CIAgent is an SNMP agent that starts, stops, and gracefully restarts Cisco SPS and monitors such information as log file sizes, CPU usage, memory size, disk space, and link status. You can have the CIAgent notify you when Cisco SPS comes up or goes down, when the size of a log file exceeds a specified limit, or when the CPU load rises above or falls below specified thresholds.

CIAgent has a master agent (snmpdm) that communicates with subagents (including critagt, smagt, and logagt) that serve their respective MIBs. The master agent, upon receipt of an SNMP request, passes it to the appropriate subagent, which retrieves or sets a specific MIB object value. Subagent responses pass back through the master agent to the requester.

CIAgent runs as root on the same system that runs Cisco SPS. Each server in a proxy-server farm should have its own CIAgent. A multiserver system therefore has multiple CIAgents, each of which controls and monitors one farm member.

When CIAgent is installed, CIAgent MIB files (file extension .my) are located in the following directory:

• Linux: /usr/local/ciagent/mibs

• Solaris: /opt/ciagent/mibs

Cisco SPS uses the MIBs and corresponding subagents listed in the “MIBs” section on page 66.

rotatelogs Utility that ships with Apache. Its use it enabled within sipd when the CustomLog directive is set to on. It is used in conjunction with Apache's piped logfile feature. For more information, refer to Cisco SIP Proxy Server Installation Guide, chapter on operating and maintaining Cisco SPS.

Yes, indirectly

dump_restorehtpasswdsysadmin_lic_val

Cisco and Apache utilities. For more information about Apache utilities, refer to the Apache HTTP server website at http://httpd.apache.org/docs-2.0/programs/logresolve.html.

No

sysadmin_sps_regroutesysadmin_mysql_user

Yes, if GUI is not installed

Table 1 Contents of the <server_root>/bin Directory (continued)

File or Script Purpose User-Accessible?

Table 2 System Account IDs and Passwords

System Default Account ID Default Password

Cisco SPS cspsuser cspsuser

MySQL guest nobody

11Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 12: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Install a New System

How to Install a New SystemThis section contains information about the following:

• Installing Cisco SPS Software in a New System, page 12

• Setting Up Servers and MySQL Databases in a New System, page 13

• Setting Up TLS Certificates (Optional), page 17

Installing Cisco SPS Software in a New System

Detailed Steps

Tip To view sample output of any scripts in this procedure, see the “Script Examples” section on page 42.

Step 1 Mount the CD-ROM drive with the Cisco SPS software, either with your Linux system’s Logical Volume Manager or as described in the “How to Mount and Unmount a CD-ROM Drive and File System” section on page 40.

Step 2 Log into Cisco SPS as root.

> su root

Step 3 Do one of the following, according to your operating system:

Linuxa. Determine whether an rpm is already installed:

# rpm -q CSPS

b. Uninstall any previous Cisco SPS versions (see the “How to Uninstall System Components” section on page 37).

c. Access the Cisco SPS software from the local or remote (/mount/cdrom) drive:

# rpm -ivh SPS-2.1.x.y-linux.i386.rpm

Solarisa. Uninstall any previous Cisco SPS versions (see the “How to Uninstall System Components” section

on page 37).

b. Access the Cisco SPS software from the local or remote (/mount/cdrom) drive:

# pkgadd -d SPS-2.1.x.y-solaris.pkg

c. Select one or all of the listed packages and follow any on-screen instructions (such as to change system parameters such as shared memory):

The following packages are available:1 CSPS Cisco Sip Proxy Server (xxx) 2.1Select package(s) you wish to process (or ‘all’ to process all packages). (default: all) [?,??,q]: all

d. Verify installation and follow any on-screen instructions (such as to change system shared memory):

# pkgchk CSPS

12Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 13: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Install a New System

Errors cause output similar to the following to appear:

ERROR: <server_root>/BUILD_VERSION permissions <0666> expected <0444> actualERROR: <server_root>/README.cisco permissions <0755> expected <0444> actual file size <26485> expected <26623> actual file cksum <6554> expected <12662> actual

Step 4 Follow any further on-screen instructions.

Note One instruction tells you to increase your shared memory size to at least 128MB. It is critical that you do so.

Step 5 Unmount the CD-ROM drive and Cisco SPS file system (see the “How to Mount and Unmount a CD-ROM Drive and File System” section on page 40).

Step 6 Reboot the system so that changed parameters take effect.

What to Do Next

You can now set up your servers and databases (see the “Setting Up Servers and MySQL Databases in a New System” section on page 13).

Setting Up Servers and MySQL Databases in a New SystemFor a new installation, you must run the SPS setup (sps_setup) script on each server as described below. The script sets up proxy servers, a provisioning server, and MySQL servers and databases as needed, and creates subscriber and other tables required by the GUI-based provisioning system.

Default script options are appropriate for most conditions. To select a default (indicated by square brackets; for example: [all]), press Enter.

You can install MySQL databases on either the same or a different machine from the one that hosts the Cisco SIP proxy server.

Prerequisites

• Perform the tasks listed in the “Administration Tasks” section on page 5.

• Ensure that no SNMP agent other than CIAgent is running on the proxy server.

• Install the Cisco SPS software (see the “Installing Cisco SPS Software in a New System” section on page 12).

• Determine which of the following four setup options to implement (see Table 3). Installation and configuration order is critical.

13Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 14: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Install a New System

• (Solaris only) If you have Solstice Enterprise Agents development and runtime environment installed and running as default SNMP agent, stop and uninstall it. For instructions on how to detect and uninstall it, refer to the troubleshooting tips.

Detailed Steps

Tip To view sample output of any scripts in this procedure, see the “Script Examples” section on page 42.

Step 1 Log into Cisco SPS as root.

> su root

Step 2 Stop all NIS processes:

# /etc/init.d/ypbind stop

Note You are advised not to run NIS on the Cisco SPS systems because doing so can cause long delays when you add a new user or user group, as explained in the note on Network Management, page 7. If you run NIS, stop NIS processes now and restart them at the end of this procedure.

Table 3 Cisco SPS Setup Options

Option Number and Note Setup Option Installation and Configuration Order

11

1. Use on the first server of a multiserver system.

Install the primary SPS of a two-server system

1. SIP proxy server

2. GUI-based provisioning system

3. Primary replicated MySQL database server

4. SNMP agent (CIAgent)

22

2. Use on the secondary server of a multiserver system that uses the GUI-based provision system, after you use option 1 on the primary server to prevent creating multiple provisioning servers and MySQL databases.

Install the secondary SPS of a two-server system

1. SIP proxy server

2. Secondary replicated MySQL database server

3. SNMP agent (CIAgent)

33

3. Use in a single-server system.

Install a stand-alone SPS 1. SIP proxy server

2. GUI-based provisioning system

3. MySQL database server

4. SNMP agent (CIAgent)

44

4. Use only if you are an expert user, understand the possible configurations of a Cisco SIP proxy server, and know your network topology. This option allows maximum configuration flexibility. Note that, to install a provisioning server, you must also install a proxy server.

Custom configuration Flexible

14Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 15: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Install a New System

Step 3 If an SNMP agent other than CIAgent is running, disable it to avoid port 161 conflict as follows:

a. Determine whether SNMP is running:

# ps -elf | grep snmp

8 S root 252 1 0 41 20 ? 264 ? 10:57:08? 0:00 /usr/lib/snmp/snmpdx -y -c /etc/snm 8 S root 261 1 0 41 20 ? 449 ? 10:57:09? 0:00 /usr/lib/dmi/snmpXdmid -s vvs-aokua 8 S root 992 286 0 56 20 ? 116 ? 13:28:40pts/1 0:00 grep snmp

b. If snmpXdmi is running, disable it as follows:

Note The following is adapted from the Carnegie Mellon Software Institute CERT Coordination Center website at http://www.cert.org/advisories/CA-2001-05.html.

1. Log in as root.

2. Prevent the daemon from starting up at reboot:

# mv /etc/rc3.d/SXXdmi /etc/rc3.d/KXXdmi

3. Kill the currently running daemon:

# /etc/init.d/init.dmi stop

4. Verify that the daemon is no longer active:

# ps -ef | grep dmi

5. (Optional) Make the daemon nonexecutable:

# chmod 000 /usr/lib/dmi/snmpXdmid

c. If snmpdx is running, disable it as follows:

Note The following text is adapted from the Sun Microsystems website at http://docs.sun.com/db/doc/816-5262/6mbdt6fst?a=view.

1. Log in as superuser.

2. Stop snmpdx:

# /etc/init.d/init.snmpdx stop

3. Prevent snmpdx from running in future:

# cd /etc/snmp/conf# mv snmpdx.rsrc snmpdx.rsrc.stop

Step 4 Run the SPS setup (sps_setup) script:

Linux: # /usr/local/sip/bin/sps_setup

Solaris: # /opt/sip/bin/sps_setup

Step 5 Select one of the following setup options:

• Install the primary SPS

• Install the secondary SPS

15Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 16: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Install a New System

• Install a stand-alone SPS

• Custom configuration

Step 6 Follow on-screen instructions until you see the message “SPS setup complete.”

Step 7 If you have a secondary proxy server to install, repeat the procedure on the other server, starting at Step 1.

Step 8 When you have installed all proxy servers, at the select prompt press Enter.

Step 9 If installation included a secondary proxy server, update the first proxy server by doing either of the following:

• Reboot the first proxy server. All processes start automatically.

• Restart the first proxy server:

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

Step 10 (GUI only) Install the provisioning GUI with your system’s InstallAnywhere software-deployment tool.

You can install the GUI to run on Windows, Linux, or Solaris machines. Run the appropriate installer and follow on-screen instructions:

Solaris: /gui/sps_gui_solaris.bin

Linux: /gui/sps_gui_linux.bin

Windows: /gui/sps_gui_windows.exe

Note After installation is complete, you can start the GUI (Linus or Solaris) by running the CiscoSPS command from the path that you chose during installation or (Windows) by clicking the CiscoSPS icon.

Step 11 (Non-GUI only): If you plan not to use the provisioning GUI to modify the SIP directives (sipd.conf) file, update the SIP scripts as follows so that subsequent manual changes to the file are not overwritten by the SIP provisioning agent during reboot or if the SIP script runs:

a. Update the script for the primary or only member:

Linux: # cd /usr/local/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip

Solaris: # cd /opt/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip

b. Update the script for secondary members:

Linux: # cd /usr/local/sip/bin# mv sip sip.bak# cp sip-dist sip

Solaris: # cd /opt/sip/bin# mv sip sip.bak# cp sip-dist sip

16Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 17: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Install a New System

Note Keep the SIP backup (sip.bak) file. You need to have a copy available should you ever want to use the provisioning GUI.

Step 12 If appropriate, restart NIS processes:

# /etc/init.d/ypbind start

Troubleshooting Tips

• If at any point you get an error message stating that the system has detected a possible running SNMP agent that may conflict with CIAgent, followed by a suggestion that you stop the other SNMP agent and rerun the setup script, stop the agent as described in Step 3 above.

• The error message “failure to create sip database” indicates that MySQL may already be installed on the proxy server. If so, uninstall it with the uninstall_mysql_db script (see the Uninstalling a MySQL Database, page 38), then rerun the sps_setup script to install the correct version of MySQL.

• In a multiserver system, be sure to bring up the primary proxy server (the box with pserver) before the secondary server.

• Check the SPS setup log (<server_root>/logs/sps_setup_log) file for debugging information.

• Verify MySQL installation:

<serverroot>/bin/mysqlshow -u guest -p Enter password: xxxxx<serverroot>/bin/mysqladmin -u guest -p version status proc Enter password: xxxxx

• If problems persist, back up all data, uninstall all relevant components (see the “How to Uninstall System Components” section on page 37), and perform the procedure again from the start.

• Review sample scripts in the “Script Examples” section on page 42.

What to Do Next

You can now alter the server configuration or provision new subscribers as described in the Cisco SIP Proxy Server Administrator Guide.

Setting Up TLS Certificates (Optional)

Detailed Steps

Step 1 Go to the TLS directory:

Linux: /usr/local/sip/conf/tls

Solaris: /opt/sip/conf/tls

17Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 18: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

Step 2 Determine whether the following files exist:

• ca.crt—Contains concatenated root certificates for certification authorities that are trusted by the proxy server

• server.crt—Contains the certificate for this proxy server

• server.key—Contains the private key for the corresponding server certificate

If they exist, exit the procedure. If they do not exist, continue with step 3.

Step 3 If the files do not exist, create them as follows:

a. Copy the proxy-server certificate to a file named server.crt.

b. Copy the proxy-server key to a file named server.key.

c. Copy all trusted certification-authority root certificates to a file named ca.crt, concatenated one after other. (Use the cat source_file >> dest_file command to concatenate them.)

Note You may name the files differently, in which case you must change the provisioning information accordingly.

d. If you named the files other than the default names, change the following server directives using the GUI-based provisioning system:

• SipTlsCertificateFile

• SipTlsCertificateKeyFile

• SipTlsCACertificateFile

How to Modify or Upgrade an Existing SystemThis section contains information about the following:

• Modifying or Deleting a Proxy Server, page 18

• Upgrading to a New Cisco SPS Software Version, page 22

• Installing CIAgent, page 31

• Installing the GUI-Based Provisioning System, page 35

Modifying or Deleting a Proxy ServerUse this procedure to modify an existing system. Typical modifications include changing an IP address or hostname or removing a proxy server. To install and set up a new system, use the “How to Install a New System” section on page 12.

18Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 19: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

Detailed Steps

Tip To view sample output of any scripts in this procedure, see the “Script Examples” section on page 42.

Step 1 Log into Cisco SPS as root.

> su root

Step 2 Back up your current data as follows:

a. (Required) Record farm-specific nondefault directive settings for both farm members. You need to have a copy in case they are ever overwritten and need to be reset. Examples of directives that you may have set to other than default follow:

b. (Recommended) Back up important files (refer to the Cisco SIP Proxy Server Administrator Guide chapter on maintenance). If something goes wrong, the procedure to restore the server using the backup files is there as well.

Step 3 Stop Cisco SPS:

Linux: # /usr/local/sip/bin/sip stop

Solaris: # /opt/sip/bin/sip stop

Step 4 Do one of the following, according to whether or not you use the provisioning GUI:

If You Use the Provisioning GUIa. Back up important MySQL data:

Linux: # /usr/local/mysql/bin/mysqldump -uguest -pnobody -t sip subscriber > \/home/CSPS/subscriber.data

# /usr/local/mysql/bin/mysqldump -uguest -pnobody -t sip CSPS > \/home/CSPS/CSPS.data

Solaris: # /opt/mysql/bin/mysqldump -uguest -pnobody -t sip subscriber > \/home/CSPS/subscriber.data

# /opt/mysql/bin/mysqldump -uguest -pnobody -t sip CSPS > \/home/CSPS/CSPS.data

b. Uninstall the current primary and secondary MySQL databases with the uninstall_mysql_db script (see the “Uninstalling a MySQL Database” section on page 38).

c. Run the SPS setup (sps_setup) script to install Cisco SPS (see the “Setting Up Servers and MySQL Databases in a New System” section on page 13) using the primary-proxy-server option followed by the secondary-proxy-server option. Follow on-screen instructions.

Note Make needed modifications or deletions at this point. Typical modifications include changing an IP address or hostname or removing a proxy server.

d. On either one of the member servers, run the MySQL-update (update_2.1.sh) script to push data into the new server. Follow on-screen instructions.

Directive Default Server 1 Setting Server 2 Setting

port 5060

ip in path headers <empty>

19Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 20: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

e. Install the provisioning GUI with your system’s InstallAnywhere software-deployment tool.

You can install the GUI to run on Windows, Linux, or Solaris machines. Run the appropriate installer and follow on-screen instructions:

Solaris: /gui/sps_gui_solaris.bin

Linux: /gui/sps_gui_linux.bin

Windows: /gui/sps_gui_windows.exe

Note After installation is complete, you can start the GUI (Linus or Solaris) by using the CiscoSPS command from the path that you chose during installation or (Windows) by clicking the CiscoSPS icon.

f. Start the proxy server:

Linux: # /usr/local/sip/bin/sip start

Solaris: # /opt/sip/bin/sip start

g. Use the provisioning GUI to update farm-specific information written during backup.

h. Restart the primary followed by the secondary proxy server so that the SIP directives (sipd.conf) file updates with the latest MySQL information and the proxy and provisioning servers can access it. Use the provisioning GUI or the restart command:

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

Note It is important to restart members in sequence, not in parallel.

If You Do Not Use the Provisioning GUIa. Back up important MySQL data:

Linux: # /usr/local/mysql/bin/mysqldump -uguest -pnobody -t sip subscriber > \/home/CSPS/subscriber.data

Solaris: # /opt/mysql/bin/mysqldump -uguest -pnobody -t sip subscriber > \/home/CSPS/subscriber.data

b. Uninstall the current MySQL database with the uninstall_mysql_db script (see the “Uninstalling a MySQL Database” section on page 38).

c. Run the SPS setup (sps_setup) script to install Cisco SPS (see the “Setting Up Servers and MySQL Databases in a New System” section on page 13) using the primary-proxy-server option followed by the secondary-proxy-server option. Follow on-screen instructions.

Note Make needed modifications or deletions at this point. Typical modifications include changing an IP address or hostname or removing a proxy server.

d. Push the subscriber data into the new MySQL database:

Linux: # /usr/local//mysql/bin/mysql -uguest -pnobody sip < \/home/CSPS/subscriber.data

20Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 21: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

Solaris: # /opt/mysql/bin/mysql -uguest -pnobody sip < /home/CSPS/subscriber.data

e. On either one of the member servers, push the old values in the SIP directives (sipd.conf) file into MySQL with the Cisco SPS configuration convertor (CSPSConfConvertor) script:

Linux: # /usr/local/sip/bin/CSPSConfConvertor -f /usr/local/sip/conf/sipd.conf \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

Solaris: # /opt/sip/bin/CSPSConfConvertor -f /opt/sip/conf/sipd.conf \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

f. Start Cisco SPS on both members to push data from MySQL to the SIP directives (sipd.conf) file:

Linux: # /usr/local/sip/bin/sip start

Solaris: # /opt/sip/bin/sip start

g. Update the SIP scripts for both members so that subsequent manual changes to the SIP directives (sipd.conf) file are not overwritten by the SIP provisioning agent during reboot or if the SIP script runs:

Linux: # cd /usr/local/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip # if primary# cp sip-dist sip # if secondary

Solaris: # cd /opt/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip # if primary# cp sip-dist sip # if secondary

Note Keep the SIP backup (sip.bak) file. You need to have a copy available should you ever want to use the provisioning GUI.

h. Update the SIP directives (sipd.conf) file for both members with farm-specific information written during backup.

i. Restart the primary followed by the secondary proxy server so that the latest values in the SIP directives (sipd.conf) file are available to the proxy and provisioning servers:

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

Note It is important to restart members in sequence, not in parallel.

Troubleshooting Tips

• Check the Cisco SPS GUI install log (Cisco_SPS_GUI_InstallLog) file for debugging information.

• If problems persist, back up all data, uninstall all relevant components (see the “How to Uninstall System Components” section on page 37), and perform the procedure again from the start.

• Review sample scripts in the “Script Examples” section on page 42.

21Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 22: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

Upgrading to a New Cisco SPS Software Version

Note • When upgrading to a farm that uses the provisioning GUI, consider the following:

– Order is important. Upgrade the system that runs the primary MySQL first.

– Make a note of directive settings that are other than the default, because they will be overwritten and may need to be reset.

• When backing up data into a file, save it into a directory outside of the <server_root> directory (Linux) /usr/local/sip or (Solaris) /opt/sip. To learn more about data backup, refer to the Cisco SIP Proxy Server Administrator Guide.

• When upgrading your operating system (as described in the “Prerequisites” section on page 2) in preparation for upgrading your Cisco SPS, store your Cisco SPS backup data on an external machine.

Upgrade Paths

Six upgrade paths to Cisco SPS 2.1 from an earlier Cisco SPS version (versions 1.2, 1.3, or 2.0) exist (see Table 4). You need to know your upgrade path for the following procedure.

Note Support for the GUI-based provisioning system is built into Cisco SPS 2.1 by default. Its use is very highly recommended but not required. Upgrade paths assume that, if you did not previously use it, you do not now plan to use it. If you do now plan to use it, proceed with your upgrade and then see the “Installing the GUI-Based Provisioning System” section on page 35.

Table 4 Cisco SPS 2.1 Upgrade Paths

Use this upgrade path...

To upgrade...

From this earlier Cisco SPS architecture To this Cisco SPS 2.1 architecture

MySQL GUI Proxy Servers MySQL GUI Proxy Servers

A Yes Yes 1 Yes Yes 1

B 2 Yes Yes 2

C No 1 Yes No 1

D 2 Yes No 2

E No No 1 Yes No 1

F 2 Yes No 2

22Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 23: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

Detailed Steps

Tip To view sample output of any scripts in this procedure, see the “Script Examples” section on page 42.

Step 1 Log into Cisco SPS as root.

> su root

Step 2 (Required) Record farm-specific nondefault directive settings for all farm members. You need to have a copy in case they are ever overwritten and need to be reset. Examples of directives that you may have set to other than default follow:

Step 3 Back up your current databases (MySQL, route, and registry) as follows:

Note Store the data in a safe place. For example, if you need to upgrade your running system to a new operating-system version (as described in the “Prerequisites” section on page 2) before upgrading it to a new Cisco SPS version, store the data on another machine.

a. (Recommended) Do a full backup:

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

b. Export registries and static routes with the regroute (sysadmin_sps_regroute) script as follows:

1. Export registries to a file with 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>

2. Export static routes to a file with 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>

Step 4 Stop Cisco SPS:

Linux: # /usr/local/sip/bin/sip stop

Solaris # /opt/sip/bin/sip stop

Step 5 Convert Cisco SPS 1.x or 2.0 MySQL data to Cisco SPS 2.1 format as follows:

a. Change your current directory to a writable location on the server that currently runs Cisco SPS.

# cd /tmp

b. Get a copy of the convert_mysql_db, convert_mysql_db_v2, and alter_dump_2.0.sh scripts from the Cisco SPS 2.1 software package.

Directive Default Server 1 Setting Server 2 Setting

port 5060

ip in path headers <empty>

23Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 24: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

Note The following example assumes that the software is on a CD-ROM that is mounted as /mnt/cdrom as described in the “Mounting a CD-ROM Drive and File System” section on page 40.

# cp /mnt/cdrom/conversion_scripts/* .

c. Run MySQL conversion scripts on the MySQL server and follow on-screen instructions as follows:

• If your upgrade path is from a version earlier than Cisco SPS 1.2 with MySQL, run the convert_mysql_db script:

# /tmp/convert_mysql_db

• If your upgrade path is from a version earlier than Cisco SPS 2.0 with MySQL or if you have just run the convert_mysql_db script, run the convert_mysql_db_v2 script:

# /tmp/convert_mysql_db_v2

Note If your upgrade path is from a version earlier than Cisco SPS 1.2, you must run both scripts.

d. Run the MySQL convert-and-store (alter_dump_2.0) script on the MySQL server and follow on-screen instructions:

# /tmp/alter_dump_2.0.sh

The script “dumps” or stores MySQL data in the correct format so that Cisco SPS 2.1 can eventually read it in.

Note Store the data in a safe place. For example, if you need to upgrade your running system to a new operating-system version (as described in the “Prerequisites” section on page 2) before upgrading it to a new Cisco SPS version, store the data on another machine.

Step 6 Uninstall the existing Cisco SPS software package as follows:

a. Uninstall the MySQL database with the uninstall_mysql_db script (see the “Uninstalling a MySQL Database” section on page 38).

b. Uninstall the Cisco SPS software package (see the “How to Uninstall System Components” section on page 37).

Step 7 Install the new Cisco SPS software package (see the “Installing Cisco SPS Software in a New System” section on page 12).

24Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 25: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

The following files are copied when Cisco SPS is installed:

Step 8 Log into Cisco SPS as root.

> su root

Step 9 Select your upgrade path A to F (see Table 4 on page 22) and complete the steps that follow:

• A. From a One-Member 2.0-or-Earlier (MySQL, GUI) System to a One-Member 2.1 (MySQL, GUI) System, page 25

• B. From a Two-Member 2.0-or-Earlier (MySQL, GUI) System to a Two-Member 2.1 (MySQL, GUI) System, page 26

• C. From a One-Member 2.0-or-Earlier (MySQL) System to a One-Member 2.1 (MySQL) System, page 27

• D. From a Two-Member 2.0-or-Earlier (MySQL) System to a Two-Member 2.1 (MySQL) System, page 28

• E. From a One-Member 2.0-or-Earlier System to a One-Member 2.1 (MySQL) System, page 29

• F. From a Two-Member 2.0-or-Earlier System to a Two-Member 2.1 (MySQL) System, page 30

A. From a One-Member 2.0-or-Earlier (MySQL, GUI) System to a One-Member 2.1 (MySQL, GUI) System

1. Run the SPS setup (sps_setup) script to install Cisco SPS using the standalone-proxy-server option (see the “Setting Up Servers and MySQL Databases in a New System” section on page 13). Follow on-screen instructions.

2. If the data that you produced by running the alter_dump_2.0.sh script (Step 5 on page 23) resides on another machine, place it somewhere that is accessible to the Cisco SPS 2.1 machine.

3. Run the MySQL update (update_2.1.sh) script and follow on-screen instructions to push data into Cisco SPS 2.1.

# <server_root>/bin/update_2.1.sh

4. Install the provisioning GUI with your system’s InstallAnywhere software-deployment tool.

You can install the GUI to run on Linux, Solaris, or Windows machines. Run the appropriate installer and follow on-screen instructions:

Linux: # /gui/sps_gui_linux.bin

Solaris: # /gui/sps_gui_solaris.bin

Windows: # /gui/sps_gui_windows.exe

File Copied Platform From This Directory To This Directory

sipd.conf.keep Linux /var/log/sipd/ /usr/local/sip/conf/

Solaris /opt/sip/conf/

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

Solaris /opt/sip/conf/

registry_db Linux /var/log/sipd/logs/ /usr/local/sip/data/

Solaris /opt/sip/data/

routing_db Linux /var/log/sipd/logs/ /usr/local/sip/data/

Solaris /opt/sip/data/

25Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 26: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

Note After installation is complete, you can start the GUI (Linus or Solaris) by running the CiscoSPS command from the path that you chose during installation or (Windows) by clicking the CiscoSPS icon.

5. Start Cisco SPS:

Linux: # /usr/local/sip/bin/sip start

Solaris: # /opt/sip/bin/sip start

6. Run the regroute (sysadmin_sps_regroute) script and follow on-screen instructions to import the previously exported registry and routing files as follows:

# ./sysadmin_sps_regroute -I <exported Registry file> -m registry# ./sysadmin_sps_regroute -I <exported Routing file> -m routing

7. Use the provisioning GUI to update farm-specific information written during backup.

8. Restart the proxy server with the provisioning GUI or the restart command so that the SIP directives (sipd.conf) file updates with the latest MySQL information and the proxy and provisioning servers can use this information:

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

B. From a Two-Member 2.0-or-Earlier (MySQL, GUI) System to a Two-Member 2.1 (MySQL, GUI) System

1. Run the SPS setup (sps_setup) script and follow on-screen instructions to install Cisco SPS using the primary-proxy-server option followed by the secondary-proxy-server option (see the “Setting Up Servers and MySQL Databases in a New System” section on page 13).

2. If the data that you produced by running the alter_dump_2.0.sh script (Step 5 on page 23) resides on another machine, place it somewhere that is accessible to the Cisco SPS 2.1 machine.

3. Run the MySQL update (update_2.1.sh) script and follow on-screen instructions to push data into Cisco SPS 2.1.

# <server_root>/bin/update_2.1.sh

4. Install the provisioning GUI with your system’s InstallAnywhere software-deployment tool.

You can install the GUI to run on Windows, Linux, or Solaris machines. Run the appropriate installer and follow on-screen instructions:

Solaris: /gui/sps_gui_solaris.bin

Linux: /gui/sps_gui_linux.bin

Windows: /gui/sps_gui_windows.exe

Note After installation is complete, you can start the GUI (Linus or Solaris) by running the CiscoSPS command from the path that you chose during installation or (Windows) by clicking the CiscoSPS icon.

5. Start Cisco SPS:

Linux: # /usr/local/sip/bin/sip start

Solaris: # /opt/sip/bin/sip start

26Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 27: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

6. Run the regroute (sysadmin_sps_regroute) script and follow on-screen instructions to import the previously exported registry and routing files as follows:

# ./sysadmin_sps_regroute -I <exported Registry file> -m registry# ./sysadmin_sps_regroute -I <exported Routing file> -m routing

7. Use the provisioning GUI to update farm-specific information written during backup.

8. Restart the primary member followed by the secondary member with the provisioning GUI or the restart command so that the SIP directives (sipd.conf) file updates with the latest MySQL information and the proxy and provisioning servers can access it:

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

Note It is important to restart members in sequence, not in parallel.

C. From a One-Member 2.0-or-Earlier (MySQL) System to a One-Member 2.1 (MySQL) System

1. Run the SPS setup (sps_setup) script and follow on-screen instructions to install Cisco SPS using the standalone-proxy-server option (see the “Setting Up Servers and MySQL Databases in a New System” section on page 13).

2. If the data that you produced by running the alter_dump_2.0.sh script (Step 5 on page 23) resides on another machine, place it somewhere that is accessible to the Cisco SPS 2.1 machine.

3. Run the MySQL update (update_2.1.sh) script and follow on-screen instructions to push data into Cisco SPS 2.1.

# <server_root>/bin/update_2.1.sh

4. Determine whether, in the SIP directives keep (sipd.conf.keep) file, the Cisco SIP Access Control configuration has the directive Order Mutual-failure. If yes, manually change it to Order Allow,Deny.

5. Push the old values in the SIP directives (sipd.conf) file into MySQL with the Cisco SPS configuration convertor (CSPSConfConvertor) script:

Linux: # /usr/local/sip/bin/CSPSConfConvertor -f \/usr/local/sip/conf/sipd.conf.keep \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

Solaris: # /opt/sip/bin/CSPSConfConvertor -f \/opt/sip/conf/sipd.conf.keep \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

6. Start Cisco SPS to push data from MySQL to the SIP directives (sipd.conf) file:

Linux: # /usr/local/sip/bin/sip start

Solaris: # /opt/sip/bin/sip start

7. Run the regroute (sysadmin_sps_regroute) script and follow on-screen instructions to import the previously exported registry and routing files as follows:

# ./sysadmin_sps_regroute -I <exported Registry file> -m registry# ./sysadmin_sps_regroute -I <exported Routing file> -m routing

27Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 28: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

8. Update the SIP script so that subsequent manual changes to the SIP directives (sipd.conf) file are not overwritten by the SIP provisioning agent during reboot or if the SIP script runs:

Linux: # cd /usr/local/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip

Solaris: # cd /opt/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip

Note Keep the SIP backup (sip.bak) file. You need to have a copy available should you ever want to use the provisioning GUI.

9. Update the SIP directives (sipd.conf) file with farm-specific information written during backup.

10. Restart the proxy server so that the latest values in the SIP directives (sipd.conf) file can be used by the proxy and provisioning servers:

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

D. From a Two-Member 2.0-or-Earlier (MySQL) System to a Two-Member 2.1 (MySQL) System

1. Run the SPS setup (sps_setup) script and follow on-screen instructions to install Cisco SPS using the primary-proxy-server option followed by the secondary-proxy-server option (see the “Setting Up Servers and MySQL Databases in a New System” section on page 13).

2. If the data that you produced by running the alter_dump_2.0.sh script (Step 5 on page 23) resides on another machine, place it somewhere that is accessible to the Cisco SPS 2.1 machine.

3. Run the MySQL update (update_2.1.sh) script and follow on-screen instructions to push data into Cisco SPS 2.1.

# <server_root>/bin/update_2.1.sh

4. Determine whether, in the SIP directives keep (sipd.conf.keep) file, the Cisco SIP Access Control configuration has the directive Order Mutual-failure. If yes, manually change it to Order Allow,Deny.

5. On either one of the member servers, push the old values in the SIP directives (sipd.conf) file into MySQL with the Cisco SPS configuration convertor (CSPSConfConvertor) script:

Linux: # /usr/local/sip/bin/CSPSConfConvertor -f \/usr/local/sip/conf/sipd.conf.keep \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

Solaris: # /opt/sip/bin/CSPSConfConvertor -f \/opt/sip/conf/sipd.conf.keep \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

6. Start Cisco SPS on both members to push data from MySQL to the SIP directives (sipd.conf) file:

Linux: # /usr/local/sip/bin/sip start

Solaris: # /opt/sip/bin/sip start

7. Run the regroute (sysadmin_sps_regroute) script and follow on-screen instructions to import the previously exported registry and routing files as follows:

# ./sysadmin_sps_regroute -I <exported Registry file> -m registry

28Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 29: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

# ./sysadmin_sps_regroute -I <exported Routing file> -m routing

8. Update SIP scripts on both members so that subsequent manual changes to the SIP directives (sipd.conf) file are not overwritten by the SIP provisioning agent during reboot or if the SIP script runs:

Linux: # cd /usr/local/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip # if primary# cp sip-dist sip # if secondary

Solaris: # cd /opt/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip # if primary# cp sip-dist sip # if secondary

Note Keep the SIP backup (sip.bak) file.You need to have a copy available should you ever want to use the provisioning GUI.

9. Update both members’ SIP directives (sipd.conf) files with farm-specific information written during backup.

10. Restart the primary followed by the secondary proxy server so that the latest values in the SIP directives (sipd.conf) file can be used by the proxy and provisioning servers:

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

Note It is important to restart members in sequence, not in parallel.

E. From a One-Member 2.0-or-Earlier System to a One-Member 2.1 (MySQL) System

1. Run the SPS setup (sps_setup) script and follow on-screen instructions to install the proxy server using the standalone-proxy-server option (see the “Setting Up Servers and MySQL Databases in a New System” section on page 13).

2. Determine whether, in the SIP directives keep (sipd.conf.keep) file, the Cisco SIP Access Control configuration has the directive Order Mutual-failure. If yes, manually change it to Order Allow,Deny.

3. Push the old values in the SIP directives (sipd.conf) files into MySQL with the Cisco SPS configuration convertor (CSPSConfConvertor) script:

Linux: # /usr/local/sip/bin/CSPSConfConvertor -f \/usr/local/sip/conf/sipd.conf.keep \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

Solaris: # /opt/sip/bin/CSPSConfConvertor -f \/opt/sip/conf/sipd.conf.keep \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

4. Start Cisco SPS to push data from MySQL to the SIP directives (sipd.conf) file:

Linux: # /usr/local/sip/bin/sip start

Solaris: # /opt/sip/bin/sip start

29Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 30: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

5. Run the regroute (sysadmin_sps_regroute) script and follow on-screen instructions to import the previously exported registry and routing files as follows:

# ./sysadmin_sps_regroute -I <exported Registry file> -m registry# ./sysadmin_sps_regroute -I <exported Routing file> -m routing

6. Update the SIP script so that subsequent manual changes to the SIP directives (sipd.conf) file are not overwritten by the SIP provisioning agent during reboot or if the SIP script runs:

Linux: # cd /usr/local/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip

Solaris: # cd /opt/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip

Note Keep the SIP backup (sip.bak) file. You need to have a copy available should you ever want to use the provisioning GUI.

7. Update the SIP directives (sipd.conf) file with farm-specific information written during backup.

8. Restart the proxy server so that latest information in the SIP directives (sipd.conf) file can be used by the proxy and provisioning servers:

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

F. From a Two-Member 2.0-or-Earlier System to a Two-Member 2.1 (MySQL) System

1. Run the SPS setup (sps_setup) script and follow on-screen instructions to install Cisco SPS using the primary-proxy-server option followed by the secondary-proxy-server option (see the “Setting Up Servers and MySQL Databases in a New System” section on page 13).

2. Determine whether, in the SIP directives keep (sipd.conf.keep) file, the Cisco SIP Access Control configuration has the directive Order Mutual-failure. If yes, manually change it to Order Allow,Deny.

3. On either one of the member servers, push the old values in the SIP directives (sipd.conf) file into MySQL with the Cisco SPS configuration convertor (CSPSConfConvertor) script:

Linux: # /usr/local/sip/bin/CSPSConfConvertor -f \/usr/local/sip/conf/sipd.conf.keep \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

Solaris: # /opt/sip/bin/CSPSConfConvertor -f \/opt/sip/conf/sipd.conf.keep \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

4. On both members, start Cisco SPS to push data from MySQL to the SIP directives (sipd.conf) file:

Linux: # /usr/local/sip/bin/sip start

Solaris: # /opt/sip/bin/sip start

5. Run the regroute (sysadmin_sps_regroute) script and follow on-screen instructions to import the previously exported registry and routing files as follows:

# ./sysadmin_sps_regroute -I <exported Registry file> -m registry# ./sysadmin_sps_regroute -I <exported Routing file> -m routing

30Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 31: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

6. Update SIP scripts for both members so that subsequent manual changes to the SIP directives (sipd.conf) file are not overwritten by the SIP provisioning agent during reboot or if the SIP script runs:

Linux: # cd /usr/local/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip # if primary

Solaris: # cd /opt/sip/bin# mv sip sip.bak# cp sip-pserver-dist sip # if primary# cp sip-dist sip # if secondary

Note Keep the SIP backup (sip.bak) file. You need to have a copy available should you ever want to use the provisioning GUI.

7. Update the SIP directives (sipd.conf) file for both members with farm-specific information written during backup.

8. Restart the primary followed by the secondary proxy server so that the latest values in the SIP directives (sipd.conf) file can be used by the proxy and provisioning servers:

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

Note It is important to restart members in sequence, not in parallel.

Step 10 If you have a multimember farm, restart the first member to ensure that the latest values in the SIP directives (sipd.conf) file are retrieved appropriately.

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

Troubleshooting Tips

• If problems persist, back up all data, uninstall all relevant components (see the “How to Uninstall System Components” section on page 37), and perform the procedure again from the start.

• Review sample scripts in the “Script Examples” section on page 42.

Installing CIAgentCIAgent is installed as part of normal Cisco SPS setup. You therefore need not perform the following procedure. It is included here only for backward compatibility and information.

Note Be sure to assign to each farm member in a server farm its own CIAgent. Each farm member has a one-to-one relationship with its colocated CIAgent in the same system, although an SNMP manager station can control or monitor all farm members through its individual CIAgent.

31Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 32: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

Two options are available for installing and upgrading CIAgent: first-time and upgrade.

Prerequisites

• Determine whether an SNMP agent is running on the system with the ps -ef|grep snmp command. If yes, do the following:

– If an SNMP agent is running on port 161 or if port 161 is in use and the SNMP agent is running on another port (as specified for SNMP in the /etc/services file), stop the SNMP agent or plan to run CIAgent on a nonstandard port.

– To run CIAgent on a nonstandard port, set the environment variable SR_SNMP_TEST_PORT to an available port. If necessary, set the environment variable SR_TRAP_TEST_PORT to specify a nonstandard trap port other than port 162. Otherwise, if you set the environment variable SR_SNMP_TEST_PORT, the trap port is the value SR_SNMP_TEST_PORT +1.

– Optionally, set the environment variable SR_HTTP_TEST_PORT to a port other than port 280 for SNMP web-management access.

– If any of the three environment variables are set for CIAgent, include them in the login, cshrc, or any shell init files that are relevant to maintain consistency.

• Determine whether a previous version of CIAgent is installed. If yes, uninstall it with the CIAgent uninstall (uninstall.CIA) script. Then use the following procedure to install the latest version.

First-Time Installation

Detailed Steps

Note Use the following procedure only for first-time installation of CIAgent. Do not use it for upgrades, because it does not keep the previous configuration. For CIAgent upgrades, use the “Upgrade Installation” section on page 33.

Tip To view sample output of any scripts in this procedure, see the “Script Examples” section on page 42.

Step 1 Log into Cisco SPS as root.

Step 2 Run the Cisco SPS CIAgent install (csps_ciagent_install) script and follow on-screen instructions.

Linux: /usr/local/sip/ciagent/csps_ciagent_install

Solaris: /opt/sip/ciagent/csps_ciagent_install

CIAgent and Cisco SPS are typically installed in the following locations:

Platform CIAgent Location Cisco SPS Location

Linux /usr/local/ciagent directory /usr/local/sip directory

Solaris /opt/ciagent directory /opt/sip directory

32Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 33: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

During installation, the following configuration files are modified to reflect the installation path and then copied into the /etc/srconf/agt directory. These files provide a basic set of configurations to CIAgent for use with Cisco SPS. You can modify them as appropriate for your environment.

• critagt.cnf

• smagt.cnf

• logagt.cnf

• eventagt.cnf

The MIB subagent population (smPopScript) script is activated to populate the script MIB subagent (smagt) with commands to gracefully restart Cisco SPS. After installation, CIAgent automatically starts.

Step 3 Add the CIAgent installation path and its bin directory to the search path as in the following example:

Linux: # setenv PATH $PATH:/usr/local/ciagent:/usr/local/ciagent/bin

Solaris: # setenv PATH $PATH:/opt/ciagent:/opt/ciagent/bin

Step 4 Repeat the procedure for a second farm member as needed.

Troubleshooting Tips

• If problems persist, back up all data, uninstall all relevant components (see the “How to Uninstall System Components” section on page 37), and perform the procedure again from the start.

• Review sample scripts in the “Script Examples” section on page 42.

Upgrade Installation

Detailed Steps

Tip To view sample output of any scripts in this procedure, see the “Script Examples” section on page 42.

Step 1 Log into Cisco SPS as root.

Step 2 Change directory to where the CIAgent installation program is located:

Linux: # cd /usr/local/sip/ciagent

Solaris: # cd /opt/sip/ciagent

Step 3 Run the installation program, install, with a parameter indicating your preferred CIAgent installation directory, as shown in the following examples:

Linux: # ./install /usr/local

Solaris: # ./install /opt

33Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 34: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

Note Install CIAgent in the same parent directory tree as Cisco SPS for easy location. For example, if Cisco SPS is installed on Linux in the /usr/local/sip directory, pass /usr/local to the script. If Cisco SPS is installed on Solaris in the /opt/sip directory, pass /opt to the script. If no parameters are provided, CIAgent is installed in the /usr/local/ciagent on both Linux and Solaris.

CIAgent automatically starts.

Step 4 Verify that CIAgent is running:

Linux: # ps -ef|grep snmpd

Solaris: # ps -ef|grep snmpd

Step 5 Add the CIAgent installation path and its bin directory to the bin search path:

Linux: # setenv PATH ${PATH}:/usr/local/ciagent:/usr/local/ciagent/bin

Solaris: # setenv PATH ${PATH}:/opt/ciagent:/opt/ciagent/bin

When CIAgent is loaded, the following processes that run as root display (Table 5).

Step 6 As needed, access the CIAgent Dr-Web interface as follows:

a. Go to the following URL:

http://<localhost, IP, or host name of the system running CIAgent>:280

(For example: http://172.16.1.1:280)

Note 280 is the default standard port for SNMP web-management access. However, if you set the environment variable SR_HTTP_TEST_PORT to a different port value before installation, you must use that port to access the Dr-Web page.

b. Enter the login (root) and password (webRootPassword).

c. Do configuration through Dr-Web (or use the “Upgrade Installation” section on page 33).

Step 7 Repeat the procedure for a second farm member as needed.

Table 5 Root Processes That Display When CIAgent Is Loaded

• ./snmpdm -tcplocal (can be 3 on Linux) • ./hostagt

• ./brassagt • ./htmlagt

• ./critagt • ./logagt

• ./mib2agt • ./sappagt

• ./eventagt • ./schdagt

• ./fsagt • ./smagt

34Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 35: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

Troubleshooting Tips

• If problems persist, back up all data, uninstall all relevant components (see the “How to Uninstall System Components” section on page 37), and perform the procedure again from the start.

• Review sample scripts in the “Script Examples” section on page 42.

Installing the GUI-Based Provisioning SystemThe GUI-based provisioning systems installs automatically with Cisco SPS 2.1. If you are upgrading from an earlier release with which you did not use the GUI and now wish to add the GUI, use the following procedure.

Detailed Steps

Tip To view sample output of any scripts in this procedure, see the “Script Examples” section on page 42.

Step 1 Log into Cisco SPS as root.

> su root

Step 2 Back up your current data as follows:

a. (Required) Record nondefault directive settings for all farm members. You need to have a copy in case they are ever overwritten and need to be reset. Examples of some that you may have set to other than default follow:

b. (Recommended) Back up important files (refer to the Cisco SIP Proxy Server Administrator Guide chapter on maintenance). If something goes wrong, the procedure to restore the server using the backup files is there as well.

Step 3 Stop Cisco SPS:

Linux: # /usr/local/sip/bin/sip stop

Solaris: # /opt/sip/bin/sip stop

Step 4 Do one of the following, according to whether your have a one-member or two-member system:

One-Member Systema. Push the values in the SIP directives (sipd.conf) file into MySQL with the Cisco SPS configuration

convertor (CSPSConfConvertor) script:

Linux: # /usr/local/sip/bin/CSPSConfConvertor -f /usr/local/sip/conf/sipd.conf \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

Solaris: # /opt/sip/bin/CSPSConfConvertor -f /opt/sip/conf/sipd.conf \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

Directive Default Server 1 Setting Server 2 Setting

port 5060

ip in path headers <empty>

35Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 36: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Modify or Upgrade an Existing System

b. Update the SIP script so that the SIP provisioning agent and license manager start up appropriately when the SIP script runs. Assuming that you backed up your original script when installing the proxy server, use the following commands:

Linux: # cd /usr/local/sip/bin# cp sip.bak sip

Solaris: # cd /opt/sip/bin# cp sip.bak sip

Note If you no longer have the SIP backup (sip.bak) file, run the SPS setup (sps_setup) script again using the standalone-proxy-server option to recreate the SIP script.

c. Install the provisioning GUI with your system’s InstallAnywhere software-deployment tool.

You can install the GUI to run on Windows, Linux, or Solaris machines. Run the appropriate installer and follow on-screen instructions:

Solaris: /gui/sps_gui_solaris.bin

Linux: /gui/sps_gui_linux.bin

Windows: /gui/sps_gui_windows.exe

Note After installation is complete, you can start the GUI (Linus or Solaris) by running the CiscoSPS command from the path that you chose during installation or (Windows) by clicking the CiscoSPS icon.

d. Use the provisioning GUI to update farm-specific information written during backup.

Two-Member System

a. On either one of the member servers, push the values in the SIP directives (sipd.conf) file into MySQL with the Cisco SPS configuration convertor (CSPSConfConvertor) script:

Linux: # /usr/local/sip/bin/CSPSConfConvertor -f \/usr/local/sip/conf/sipd.conf \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

Solaris: # /opt/sip/bin/CSPSConfConvertor -f \/opt/sip/conf/sipd.conf \-n <dbname> -h <sqlhost> -u <sqluser> -p <sqlpasswd>

b. Update the SIP script on both servers so that the SIP provisioning agent and license manager start up appropriately when the SIP script runs. Assuming that you backed up your original script when installing the proxy server, use the following commands:

Linux: # cd /usr/local/sip/bin# cp sip.bak sip

Solaris: # cd /opt/sip/bin# cp sip.bak sip

36Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 37: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Uninstall System Components

Note If you no longer have the SIP backup (sip.bak) file, run the SPS setup (sps_setup) script again using the primary-proxy-server option followed by the secondary-proxy-server option accordingly to recreate the SIP script. Then perform this and subsequent steps on first one farm member and, when done, on the second member.

c. Install the provisioning GUI with your system’s InstallAnywhere software-deployment tool.

You can install the GUI to run on Windows, Linux, or Solaris machines. Run the appropriate installer and follow on-screen instructions:

Solaris: /gui/sps_gui_solaris.bin

Linux: /gui/sps_gui_linux.bin

Windows: /gui/sps_gui_windows.exe

Note After installation is complete, you can start the GUI (Linus or Solaris) by running the CiscoSPS command from the path that you chose during installation or (Windows) by clicking the CiscoSPS icon.

d. Use the provisioning GUI to update farm-specific information written during backup.

Step 5 Restart the proxy server s (primary followed by secondary) so that the SIP directives (sipd.conf) file updates with the latest MySQL information and the proxy and provisioning servers can use this information. Use the provisioning GUI or the restart command:

Linux: # /usr/local/sip/bin/sip restart

Solaris: # /opt/sip/bin/sip restart

Note It is important to restart members in sequence, not in parallel.

How to Uninstall System ComponentsThis section contains information about the following:

• Uninstalling a MySQL Database, page 38

• Uninstalling a Proxy Server, page 38

• Uninstalling CIAgent, page 40

Note If you wish to uninstall both a MySQL database and a proxy server, uninstall the database first. Uninstalling the proxy server deletes the script needed to uninstall the database.

37Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 38: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Uninstall System Components

Uninstalling a MySQL Database

Detailed Steps

Tip To view sample output of any scripts in this procedure, see the “Script Examples” section on page 42.

Step 1 Log into Cisco SPS as root.

> su root

Step 2 (Optional) To prevent calls from being incorrectly handled by the associated proxy server after the database is removed, stop Cisco SPS processes:

Linux: # /usr/local/sip/bin/sip stop

Solaris: # /opt/sip/bin/sip stop

Step 3 Run the uninstall MySQL uninstall (uninstall_mysql) script and follow on-screen instructions:

Linux: # /usr/local/sip/bin/uninstall_mysql_db

Solaris: # /opt/sip/bin/uninstall_mysql_db

Uninstalling a Proxy Server

Caution Uninstallation completely removes a Cisco SIP proxy server. If you want to upgrade your system, do not follow these instructions. Instead, use the upgrade instructions in the “Upgrading to a New Cisco SPS Software Version” section on page 22.

Detailed Steps

Tip To view sample output of any scripts in this procedure, see the “Script Examples” section on page 42.

Step 1 Log into Cisco SPS as root.

> su root

Step 2 Stop Cisco SPS processes:

Linux: # /usr/local/sip/bin/sip stop

Solaris: # /opt/sip/bin/sip stop

Step 3 If you plan to uninstall MySQL, do so at this point (see the “How to Uninstall System Components” section on page 37).

38Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 39: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Uninstall System Components

Note The following step removes the installation package, including the script needed to uninstall the MySQL database. If you wish to uninstall the database, you must do so at this point.

Step 4 Remove the Cisco SPS installation package:

Linux: # rpm -e CSPS

Solaris: # pkgrm CSPS

The following directories are created by the command when a proxy server is removed:

Step 5 Go to the /var/log/sipd/ directory and copy everything to another machine.

Note Keep these files. You need to have a copy available in case you ever want to reinstall or upgrade Cisco SPS on another machine.

Step 6 Remove miscellaneous files:

Linux: # rm -rf /usr/local/sip /etc/init.d/sip /etc/rc3.d/S95sip

Solaris: # rm -rf /opt/sip /etc/init.d/sip /etc/rc3.d/S95sip

Caution The following step removes all backups of your Cisco SPS data, including all of those listed in Step 4 above.

Step 7 (Optional) If you do not plan to reinstall or upgrade Cisco SPS on this machine, remove backup files:

Linux: # rm -rf /usr/local/sip# rm -rf /var/log/sipd

Solaris: # rm -rf /opt/sip# rm -rf /var/log/sipd

Directory (Linux or Solaris) Contents

/var/log/sipd/conf All configuration files in the <server_root>/conf directory, with .keep appended to the filename

/var/log/sipd/conf/tls Certificates and keys used for TLS from the <server_root>/conf/tls directory, (if any)

/var/log/sipd/data registry_db and routing_db from the <server_root>/data directory

/var/log/sipd/logs All log files in the <server_root/logs> directory

39Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 40: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Mount and Unmount a CD-ROM Drive and File System

Uninstalling CIAgent

Detailed Steps

Step 1 Access CIAgent in the following location:

Linux: /usr/local/ciagent directory

Solaris: /opt/ciagent directory

Step 2 At the system prompt, do the following:

Linux: # cd /usr/local/ciagent/# uninstall.CIA

Solaris: # cd /opt/ciagent# uninstall.CIA

How to Mount and Unmount a CD-ROM Drive and File SystemThis section contains information about the following:

• Mounting a CD-ROM Drive and File System, page 40

• Unmounting a CD-ROM Drive and File System, page 42

Mounting a CD-ROM Drive and File SystemCisco SPS software is delivered on a CD-ROM, the contents of which you install on your Linux or Solaris system. Before you can install the software, however, you must mount—that is, enable your system to access—the CD-ROM drive and CD-ROM file system. The drive can be on your local Linux or Solaris system or remote. A mounted file system on a remote drive is said to be exported.

Note You can mount the CD-ROM drive and Cisco SPS file system with the Linux system’s Logical Volume Manager online disk-storage-management subsystem or, for either Linux or Solaris systems, as described in the following steps.

Detailed Steps

Step 1 Log into the system on which the CD-ROM drive resides as root.

> su root

Step 2 Insert the Cisco SPS CD-ROM into the drive.

Step 3 If the /mnt/cdrom directory does not already exist, create it:

# mkdir /mnt/cdrom

40Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 41: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1How to Mount and Unmount a CD-ROM Drive and File System

Step 4 Mount the CD-ROM drive.

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

Solaris: # mount -F hsfs -r /dev/sr0 /mnt/cdrom

You can now access the CD-ROM (read-only) from the /mnt/cdrom directory.

Step 5 (Solaris only) If the drive is remote, do the following:

a. Determine whether the remote system is enabled as a Network File System (NFS) server:# ps -ef | grep nfs | grep -v grep

Does the command output contains one of the following lines?

/usr/lib/nfs/nfsd/usr/lib/nfs/mountd

• If yes, the system is already enabled as an NFS server. Continue with step c.

• If no, the system needs to be enabled as an NFS server. Continue with step b.

b. If necessary, enable the remote system as an NFS server:# /etc/init.d/nfs.server start

c. Export the mounted CD-ROM drive:

# share -F nfs -o ro,anon=0 /mnt/cdrom

d. Log into the local Cisco SPS system as root.

> su root

e. If the /mnt/cdrom directory does not already exist, create it:

# mkdir /mnt/cdrom

f. Ensure that the /mnt/cdrom directory is not already a mounted file system:

# df /mnt/cdrom

• If the output is similar to the following, a file system is already mounted on the local system’s /mnt/cdrom directory. Continue with step g.

/mnt/cdrom (remote_machine:/mnt/cdrom): 3139134 blocks -1 files

• If the output is similar to the following, the directory is not a mounted file system. Continue with step h.

/mnt/cdrom (/dev/dsk/c0t3d0s5):328614 blocks 586775 files

g. If necessary, unmount the existing directory:

# umount /mnt/cdrom

h. Mount the exported CD-ROM drive on the local system:

# mount -r <remote-machine>:/mnt/cdrom /mnt/cdrom

Note <remote-machine> is a valid IP address or hostname.

41Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 42: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

Caution Do not manually eject a mounted CD-ROM. Unmount it properly (see the “Unmounting a CD-ROM Drive and File System” section on page 42).

Troubleshooting Tips

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

• If problems persist, back up all data, uninstall all relevant components, and perform the procedure again from the start.

• Review sample scripts in the “Script Examples” section on page 42.

Unmounting a CD-ROM Drive and File System

Detailed Steps

Step 1 If the drive is remote, do the following:

a. Log into the remote system as root.

> su root

b. Unexport the CD-ROM file system:

# inshore /mnt/cdrom

Step 2 Log into the local system as superuser or root.

> su root

Step 3 Unmount the CD-ROM drive:

Local drive: # umount /mnt/cdrom

Remote drive: # umount /mnt/cdrom

Step 4 Eject the CD-ROM:

# eject

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

Script ExamplesThis section contains the following script examples:

• SPS Software Installation Script, page 43

• SPS Setup (sps_setup) Scripts, page 47

• MySQL Conversion (convert_mysql_db_v2) Script, page 52

• MySQL Convert-and-Store (alter_dump_2.0.sh) Script, page 54

• MySQL Update (update_2.1.sh) Script, page 54

42Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 43: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

• MySQL Uninstall (uninstall_mysql_db) Script, page 55

• Cisco SPS Configuration Convertor (CSPSConfConvertor) Script, page 55

• CIAgent Install (csps_ciagent_install) Script, page 59

Note Scripts vary according to operating system and other parameters. The scripts that display on your system therefore differ from those shown below. For example, on a Linux 7.3 system, MySQL is installed by default and the sps_setup script prompts you to remove the rpm and all related rpms before installing a new MySQL server.

SPS Software Installation Script

Linux System

Router# rpm -ivh SPS-2.1.x.y-linux.i386.rpm

Preparing... ###########################################[100%]Creating csps user and group.This could take some time.Warning: csps group exists. Assuming group has been created by previous CSPS installation.Warning: csps user exists. Assuming user has been created by previous CSPS installation. 1:CSPS ###########################################[100%]Postinstall: Copying /var/log/sipd/conf/lm.conf.keep to /usr/local/sip/conf/lm.conf.keepPostinstall: Copying /var/log/sipd/conf/ps.conf.keep to /usr/local/sip/conf/ps.conf.keepPostinstall: Copying /var/log/sipd/conf/spa.conf.keep to /usr/local/sip/conf/spa.conf.keepPostinstall: Copying /var/log/sipd/conf/sipd.conf.keep back to /usr/local/sip/conf/sipd.conf.keep Copying /var/log/sipd/conf/sipd.conf-dist.keep back to /usr/local/sip/conf/sipd.conf-dist.keep#############################################################\nPlease configure the sipd.conf properly before you start sipd\n

-------------------------------------------------------------\n

You can run "diff sipd.conf-dist sipd.conf-dist.keep"to find out new directives introduced in this releaseand run "diff sipd.conf-dist.keep sipd.conf.keep"to find out all your changes to the sipd.conf

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Please update your shared memory to be at least 128 MB.-------------------------------------------------------Your shared memory is specified in the file /proc/sys/kernel/shmmaxTo increase your shared memory to 128 MB, you can do the following:

1) su root 2) echo 134217728 > /proc/sys/kernel/shmmax 3) exit

43Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 44: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

However, on machine reboot /proc/sys/kernel/shmmax will return tothe default setting.

To set shared memory to be 128 MB when your system is rebooted, youcan do the following:

Edit /etc/rc.d/rc.local Add the following to the end of the file: # Increase shmmax to 128 MB if [ -f /proc/sys/kernel/shmmax ]; then expr 128 \* 1024 \* 1024 > /proc/sys/kernel/shmmax fi

For additional shared memory notes please refer to /usr/local/sip/README.cisco

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Router#

Solaris System

Router# pkgadd -d SPS-2.1.x.y-solaris.pkg

The following packages are available: 1 CSPS Cisco SIP Proxy Server (sparc) Version 2.1.x.y

Select package(s) you wish to process (or 'all' to processall packages). (default: all) [?,??,q]:

Processing package instance <CSPS> from </SPS-2.1.x.y-solaris.pkg>

Cisco SIP Proxy Server(sparc) Version 2.1.x.yCisco Systems## Executing checkinstall script.## Processing package information.## Processing system information. 1 package pathname is already properly installed.## Verifying disk space requirements.## Checking for conflicts with packages already installed.## Checking for setuid/setgid programs.

This package contains scripts which will be executed with super-userpermission during the process of installing this package.

Do you want to continue with the installation of <CSPS> [y,n,?] y

Installing Cisco SIP Proxy Server as <CSPS>

## Executing preinstall script.Warning: csps group exists. Assuming group has been created by a previous CSPS installation.Warning: csps user exists. Assuming user has been created by a previous CSPS installation.## Installing part 1 of 1./opt/sip/BUILD_VERSION/opt/sip/README.cisco/opt/sip/bin/CSPSConfConvertor/opt/sip/bin/Sip_Services/opt/sip/bin/alter_dump_2.0.sh/opt/sip/bin/convert_mysql_db

44Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 45: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

/opt/sip/bin/convert_mysql_db_v2/opt/sip/bin/dump_restore/opt/sip/bin/htpasswd/opt/sip/bin/install_mysql_db/opt/sip/bin/licenseMgr/opt/sip/bin/lmctl/opt/sip/bin/logresolve/opt/sip/bin/mysql_sync_check.sh/opt/sip/bin/pserver/opt/sip/bin/pserverctl/opt/sip/bin/regroute_cli/opt/sip/bin/rotatelogs/opt/sip/bin/sip-dist/opt/sip/bin/sipd/opt/sip/bin/sipdctl/opt/sip/bin/spa/opt/sip/bin/spactl/opt/sip/bin/sps_setup/opt/sip/bin/sysadmin_lic_val/opt/sip/bin/sysadmin_mysql_user/opt/sip/bin/sysadmin_sps_regroute/opt/sip/bin/uninstall_mysql_db/opt/sip/bin/update_2.1.sh/opt/sip/ciagent/README/opt/sip/ciagent/README.first/opt/sip/ciagent/ciagent.sri/opt/sip/ciagent/conf/critagt.cnf/opt/sip/ciagent/conf/eventagt.cnf/opt/sip/ciagent/conf/logagt.cnf/opt/sip/ciagent/conf/smPopScript/opt/sip/ciagent/conf/snmpd.cnf/opt/sip/ciagent/csps_ciagent_ctl/opt/sip/ciagent/csps_ciagent_install/opt/sip/ciagent/customize/opt/sip/ciagent/decode/opt/sip/ciagent/install/opt/sip/conf/license.conf-dist/opt/sip/conf/lm.conf/opt/sip/conf/magic/opt/sip/conf/mime.types/opt/sip/conf/persistent_tcp.conf-dist/opt/sip/conf/ps.conf/opt/sip/conf/sip_registry.conf-dist/opt/sip/conf/sip_routing.conf-dist/opt/sip/conf/sipd.conf/opt/sip/conf/sipd.conf-dist/opt/sip/conf/spa.conf/opt/sip/lib/libapr.a/opt/sip/lib/libapr.la/opt/sip/lib/libaprutil.a/opt/sip/lib/libaprutil.la/opt/sip/libexec/libACE.so/opt/sip/libexec/libSip_Dump_Restore.so/opt/sip/libexec/libsdcapi.so.1/opt/sip/libexec/libsipfarm.so/opt/sip/libexec/libsipnumsvclient.so/opt/sip/libexec/libsipregistryclient.so/opt/sip/libexec/libsiproutingclient.so/opt/sip/libexec/libsipservices.so/opt/sip/libexec/libstdc++.so.2.10.0/opt/sip/libexec/libxalan-c1_4_0.so/opt/sip/libexec/libxerces-c.so.21/opt/sip/mysql/mysql/opt/sip/mysql/mysql-3.23.54a-sun-solaris2.8-sparc.tar.gz

45Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 46: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

[ verifying class <none> ]## Executing postinstall script.###########################################################

IMPORTANT ! IMPORTANT ! IMPORTANT ! IMPORTANT ! IMPORTANT !-----------------------------------------------------------

Postinstall: Copying /var/log/sipd/conf/license.conf.keep back to /opt/sip/conf/license.conf.keepPostinstall: Copying /var/log/sipd/conf/persistent_tcp.conf.keep back to /opt/sip/conf/persistent_tcp.conf.keepPostinstall: Copying /var/log/sipd/conf/lm.conf.keep to /opt/sip/conf/lm.conf.keepPostinstall: Copying /var/log/sipd/conf/ps.conf.keep to /opt/sip/conf/ps.conf.keepPostinstall: Copying /var/log/sipd/conf/spa.conf.keep to /opt/sip/conf/spa.conf.keepPostinstall: Copying /var/log/sipd/conf/sipd.conf.keep back to /opt/sip/conf/sipd.conf.keep Copying /var/log/sipd/conf/sipd.conf-dist.keep back to /opt/sip/conf/sipd.conf-dist.keep#############################################################

Please configure the sipd.conf properly before you start sipd

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

You can run "diff sipd.conf-dist sipd.conf-dist.keep"to find out new directives introduced in this releaseand run "diff sipd.conf-dist.keep sipd.conf.keep"to find out all your changes to the sipd.conf

Copying registry_db file back into /opt/sip/data

Copying routing_db file back into /opt/sip/data

The following kernel parameters are recommended to be addedto /etc/system file to run Cisco SIP Proxy Server.

set shmsys:shminfo_shmmax=134217728set shmsys:shminfo_shmmin=1set shmsys:shminfo_shmmni=100set shmsys:shminfo_shmseg=32

Then run the following command:touch /reconfigure

.... YOU MUST REBOOT THE SYSTEM AFTER ADDING THESE LINES ....

#############################################################

Installation of <CSPS> was successful.Router#

46Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 47: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

SPS Setup (sps_setup) Scripts

Option 1: Install the Primary SPS of a Two-Server System

Router1# /opt/sip/bin/sps_setup

+-------------------------------------------------------------------------| Welcome to Cisco SIP Proxy Server (SPS), version 2.1.|| [1]) Install the Primary SPS of a two server system|| 2) Install the Secondary SPS of a two server system|| 3) Install a stand-alone SPS|| 4) Custom configuration|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: 1+-------------------------------------------------------------------------| Choose the network interface the servers will use to communicate with| the other farm servers.|| [1]) 10.1.100.64| 2) 10.1.100.64|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: 2+-------------------------------------------------------------------------| Please enter the SPS License Key.|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx+-------------------------------------------------------------------------| Please enter the Proxy Domain.|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: sip.com+-------------------------------------------------------------------------| MySQL is currently not installed in /opt/mysql/bin| Do you wish to continue and install MySQL-3.23.54?| [ Yes ] / No|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: Yes+-------------------------------------------------------------------------| Enter the Host name or IP address of the Secondary server.|| Q) Quit| ?) Help+-------------------------------------------------------------------------

47Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 48: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

Answer: 10.1.100.65+-------------------------------------------------------------------------| 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:

+-------------------------------------------------------------------------| Are the following settings correct?|| Proxy Domain: "sip.com"| IP Address: "10.1.100.64"| MySQL Primary Host: "10.1.100.64"| MySQL Secondary Host: "10.1.100.65"| MySQL will be installed as the primary server.|| [ Yes ] / No|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: YesInstalling MySQL. This may take a while ... complete./etc/init.d/mysql: @HOSTNAME@: not foundKilling mysqld with pid 9248/etc/init.d/mysql: @HOSTNAME@: not foundStarting mysqld daemon with databases from /opt/mysql/dataUpdated LicenseKey in TempLicense table.Updated LicenseKey in License table.Updated ControlCSPS table.Updated CSPS table in MySQL.Created /opt/sip/conf/license.confCreated /opt/sip/conf/spa.confCreated /opt/sip/conf/ps.confCreated /opt/sip/conf/lm.confCreated /opt/sip/conf/sipd.confStopping sipd.../opt/sip/bin/sipdctl stop: sipd not runningStopping spa.../opt/sip/bin/spactl stop: spa not runningStopping license manager.../opt/sip/bin/lmctl stop: licenseMgr not runningStopping pserver.../opt/sip/bin/pserverctl stop: pserver not runningInstalling snmp. This may take a while ... snmp installation complete.+-------------------------------------------------------------------------|| SPS setup complete.|+-------------------------------------------------------------------------

48Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 49: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

Option 2: Install the Secondary SPS of a Two-Server System

Router2# /opt/sip/bin/sps_setup

+-------------------------------------------------------------------------| Welcome to Cisco SIP Proxy Server (SPS), version 2.1.|| [1]) Install the Primary SPS of a two server system|| 2) Install the Secondary SPS of a two server system|| 3) Install a stand-alone SPS|| 4) Custom configuration|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: 2+-------------------------------------------------------------------------| Choose the network interface the servers will use to communicate with| the other farm servers.|| [1]) 10.1.100.65| 2) 10.1.100.65|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: 2+-------------------------------------------------------------------------| Please enter the SPS License Key.|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx+-------------------------------------------------------------------------| Enter the host name or IP address of the primary server.|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: 10.1.100.64+-------------------------------------------------------------------------| MySQL is currently not installed in /opt/mysql/bin| Do you wish to continue and install MySQL-3.23.54?| [ Yes ] / No|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: Yes+-------------------------------------------------------------------------| 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:

49Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 50: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

Enter the MySQL Server Administrator's password again.

Password:

+-------------------------------------------------------------------------| Are the following settings correct?|| IP Address: "10.1.100.65"| PServer Host: "10.1.100.64"| MySQL Primary Host: "10.1.100.64"| MySQL Secondary Host: "10.1.100.65"| MySQL will be installed as the secondary server.|| [ Yes ] / No|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: YesInstalling MySQL. This may take a while ... complete./etc/init.d/mysql: @HOSTNAME@: not foundKilling mysqld with pid 8934/etc/init.d/mysql: @HOSTNAME@: not foundStarting mysqld daemon with databases from /opt/mysql/dataUpdated LicenseKey in TempLicense table.Updated LicenseKey in License table.Updated ControlCSPS table.Updated CSPS table in MySQL.Created /opt/sip/conf/license.confCreated /opt/sip/conf/spa.confCreated /opt/sip/conf/sipd.confStopping sipd.../opt/sip/bin/sipdctl stop: sipd not runningStopping spa.../opt/sip/bin/spactl stop: spa not runningInstalling snmp. This may take a while ... snmp installation complete.+-------------------------------------------------------------------------|| SPS setup complete.|+-------------------------------------------------------------------------

Option 3: Install a Stand-Alone SPS

Router# /opt/sip/bin/sps_setup

+-------------------------------------------------------------------------| Welcome to Cisco SIP Proxy Server (SPS), version 2.1.|| [1]) Install the Primary SPS of a two server system|| 2) Install the Secondary SPS of a two server system|| 3) Install a stand-alone SPS|| 4) Custom configuration|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: 3

50Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 51: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

+-------------------------------------------------------------------------| Choose the network interface the servers will use to communicate with| the other farm servers.|| [1]) 10.1.100.66| 2) 10.1.100.66|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: 1+-------------------------------------------------------------------------| Please enter the SPS License Key.|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx+-------------------------------------------------------------------------| Please enter the Proxy Domain.|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: sip.com+-------------------------------------------------------------------------| You currently have MySQL-3.23.54 installed in /opt/mysql/bin| Do you wish to continue and use it to store SPS data?| Please enter ? for more help/details.| [ Yes ] / No|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: Yes+-------------------------------------------------------------------------| 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:

+-------------------------------------------------------------------------| Are the following settings correct?|| Proxy Domain: "sip.com"| IP Address: "10.1.100.66"| MySQL Host: "localhost"|| [ Yes ] / No|| Q) Quit| ?) Help+-------------------------------------------------------------------------Answer: YesUpdated LicenseKey in TempLicense table.

51Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 52: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

Updated LicenseKey in License table.Updated ControlCSPS table.Updated CSPS table in MySQL.Created /opt/sip/conf/license.confCreated /opt/sip/conf/spa.confCreated /opt/sip/conf/ps.confCreated /opt/sip/conf/lm.confCreated /opt/sip/conf/sipd.confStopping sipd.../opt/sip/bin/sipdctl stop: sipd not runningStopping spa.../opt/sip/bin/spactl stop: spa not runningInstalling snmp. This may take a while ... snmp installation complete.+-------------------------------------------------------------------------|| SPS setup complete.|+-------------------------------------------------------------------------

MySQL Conversion (convert_mysql_db_v2) ScriptRouter# ./convert_mysql_db_v2

convert_mysql_db_v2 Version 2.x.x.xbuilt: Aug xx 2003

+------------------------------------------------------------------+| This script can be used to convert a MySQL subscriber database || for use with a Cisco SIP Proxy Server (v1.2 or v1.3) to a MySQL || subscriber database for use with a Cisco SIP Proxy Server v2.0. |+------------------------------------------------------------------+

Detected operating system is: LinuxDetected machine type is: i686Detected hostname of this machine as: vvs-alder.cisco.comUsing detected mysql client at: /usr/bin/mysql/bin/egrepUsing detected egrep utility at: /bin/egrep/bin/cutUsing detected cut utility at: /bin/cut

+------------------------------------------------------------------+| We're now going to prompt you for the sipd.conf file to be used || by the proxy to extract the MySQL database information || (DB_MySQL_HostName, DB_MySQL_DB, DB_MySQL_Username, || DB_MySQL_Password, DB_MySQL_Subscriber_Table and || DB_MySQL_UserId_Field) and the ProxyDomain directive from it. || That domain will be added as the default domain for all your || subscribers in the previous database. You can always change or || update their domains later. || || IF YOU PLAN TO USE THE NEW PROVISIONING SYSTEM: || If the database name, subscriber table name or subscriber || table fields have been modified and do not have the default || values (see admin guide for more details) then modify || them to the default values before running this script. || If you don't plan to use the provisioning system then the || database does not need to be modified. |+------------------------------------------------------------------+

Enter the sipd.conf file to be used by the proxy: [../conf/sipd.conf.keep]/usr/local/sip/conf/sipd.conf

52Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 53: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

Using ../conf/sipd.conf.keep to retrieve MySQL database information

+------------------------------------------------------------------+| Obtaining the following information from ../conf/sipd.conf.keep |+------------------------------------------------------------------+MySQL server = localhostMySQL database name = sipMySQL username = guestMySQL password = nobodyMySQL subscriber table name = subscriberMySQL UserId field name = user_iddefault domain_name = cisco.com

+------------------------------------------------------------+| Add a new DOMAIN_NAME field |+------------------------------------------------------------+Operation successful.

+------------------------------------------------------------+| Add a new USER_DOMAIN field |+------------------------------------------------------------+Operation successful.

+------------------------------------------------------------------+| Populate USER_DOMAIN field for all existing users |+------------------------------------------------------------------+

+------------------------------------------------------------------+ | Finished populating USER_DOMAIN field for all users |+------------------------------------------------------------------+

+------------------------------------------------------------+| Add CONTACT_INFO new fields |+------------------------------------------------------------+Operation successful.

+------------------------------------------------------------+| Converting type of USER_ID, PASSWORD, FIRST_NAME, || LAST_NAME, and MIDDLE NAME to 'char(255)' |+------------------------------------------------------------+Operation successful.

+------------------------------------------------------------+| Make USER_DOMAIN the primary key |+------------------------------------------------------------+Operation successful.

+------------------------------------------------------------+| Add new tables introduced by provisioning: || CspsStaticRoute, CSPS, License, TempLicense and Seeding |+------------------------------------------------------------+

+-----------------------------------------+| Subscriber database conversion complete |+-----------------------------------------+

53Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 54: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

MySQL Convert-and-Store (alter_dump_2.0.sh) ScriptThe script “dumps” or stores MySQL data in the correct format so that Cisco SPS 2.1 can eventually read it in.

Router1/opt/sip/bin# ./alter_dump_2.0.sh

+------------------------------------------------------------------------| Please enter the directory where you want to store the data| that will be used later by update_2.1.sh.| IMPORTANT that this path not be under /opt/sip:+------------------------------------------------------------------------/backupThe backup directory /backup exists ... ok.+------------------------------------------------------------------------| Please enter the MySQL user that can access the MySQL database.| <CR> default will be [guest]:+------------------------------------------------------------------------

+------------------------------------------------------------------------| Please enter the associated MySQL password.| <CR> default will be [nobody]:+------------------------------------------------------------------------

+------------------------------------------------------------------------| Please confirm the following:| All data will be written to: /backup| MySQL user is: guest| MySQL password is: nobody| Is this correct? [y]/n+------------------------------------------------------------------------

+---------------------------------------------------------------------| Congratulations. This script has created 5 files in /backup:| sip_backup.db = original full database| subscriber.db = original subscriber database from CSPS 2.0| CSPS.db = original sipd.conf database from CSPS 2.0| subscriber.data = altered subscriber data for CSPS 2.1| CSPS.data = altered sipd.conf data for CSPS 2.1| You will need subscriber.data and CSPS.data when upgrading to CSPS 2.1+---------------------------------------------------------------------

MySQL Update (update_2.1.sh) ScriptRouter1/opt/sip/bin# ./update_2.1.sh

+------------------------------------------------------------------------| Please enter the directory where you want to retrieve the data| created by alter_dump_2.0.sh when run against a CSPS 2.0 database:+------------------------------------------------------------------------/backupThe backup directory /backup exists ... ok.The file /backup/CSPS.data exists ... ok.The file /backup/subscriber.data exists ... ok.+------------------------------------------------------------------------| Please enter the MySQL user that can access the MySQL database.| <CR> default will be [guest]:+------------------------------------------------------------------------

+------------------------------------------------------------------------| Please enter the associated MySQL password.

54Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 55: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

| <CR> default will be [nobody]:+------------------------------------------------------------------------

+------------------------------------------------------------------------| Please confirm the following:| All data will be read from: /backup| MySQL user is: guest| MySQL password is: nobody| Is this correct? [y]/n+------------------------------------------------------------------------y+---------------------------------------------------------------------| Congratulations. This script has updated your mysql database| using the following files in /backup| subscriber.data = altered subscriber data from CSPS 2.0| CSPS.data = altered sipd.conf data from CSPS 2.0+---------------------------------------------------------------------

MySQL Uninstall (uninstall_mysql_db) ScriptRouter1# /opt/sip/bin/uninstall_mysql_db

uninstall_mysql_db Version 2.x.x.xbuilt: Aug xx 2003

Detected operating system is: SunOSDetected machine type is: sun4uThis script is being run by user id: 0

This script will uninstall the MySQL server and MySQL client components.Do you wish to continue? [y/n]yContinuing uninstall operation...Are you sure? This will remove ALL CSPS database information. [y/n]yStoping mysqld.../etc/init.d/mysql: @HOSTNAME@: not foundKilling mysqld with pid 8981Wait for mysqld to exit030613 14:34:26 mysqld ended

doneRemoving /opt/mysql...Uninstall operation complete.

Cisco SPS Configuration Convertor (CSPSConfConvertor) ScriptRouter:/opt/sip/bin# ./CSPSConfConvertor -f /opt/sip/conf/sipd.conf -n sip -h 67.1.100.64 -u guest -p nobody

Accounting OffAccountingClientSide OffAccountingRecordFormat RadiusAccountingServerSide OnAccountingTimeFormat GMTAccountingUnsuccessful OffAcctIncludeSIPHeader <table></table>AddDiversionHeader OnAddRecordRoute OffAllow <table></table>

55Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 56: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

AuthAllow3rdPartyInvite OnAuthAllow3rdPartyRegistration OnAuthConsumeProxyAuth OnAuthDigestAlgorithm MD5AuthDigestQop authAuthIncludeSIPHeader <table></table>AuthRealm CISCOAuthScheme HTTP_DigestAuthServer ProxyAuthentication OffCallForwardBusy OffCallForwardNoAnswer OffCallForwardNoAnswerTimer 24000CallForwardUnavailable OffCallForwardUnavailableTimer 24000CallForwardUnconditional OffCisco_Enum OffCisco_Enum_Global_Domain e164.arpa.Cisco_Numexpand OnCisco_Registry OnCisco_Registry_Max_DB_Age_on_Boot 86400Cisco_Registry_Remote_Update_Port 22931Cisco_Registry_Rendezvous_Name registry_dbCisco_Registry_Shared_Memory_Address 0x30000000Cisco_Registry_Use_Virtual_Proxy_Host OffCisco_Routing OnCisco_Routing_Global_Less_Specific_Route_Search OffCisco_Routing_Max_DB_Age_on_Boot 86400Cisco_Routing_Remote_Update_Port 22913Cisco_Routing_Rendezvous_Name routing_dbCisco_Routing_Shared_Memory_Address 0x35000000Cisco_Routing_Wildcard_Expand_Length 25CustomLog <table><row><file>logs/access_log</file><name>common</name></row></table>DB_MySQL OnDB_MySQL_Connect_Timeout 1DB_MySQL_DB sipDB_MySQL_Dest_URL_CFB_Field dest_url_cfbDB_MySQL_Dest_URL_CFNA_Field dest_url_cfnaDB_MySQL_Dest_URL_CFUNC_Field dest_url_cfuncDB_MySQL_Dest_URL_CFUNV_Field dest_url_cfunvDB_MySQL_DomainName_Field domain_nameDB_MySQL_FirstName_Field first_nameDB_MySQL_HostName 192.1.100.64DB_MySQL_LastName_Field last_nameDB_MySQL_MiddleName_Field middle_nameDB_MySQL_Password nobodyDB_MySQL_Password_Field passwordDB_MySQL_Secondary_HostName 192.1.100.65DB_MySQL_Subscriber_Table subscriberDB_MySQL_UserId_Field user_idDB_MySQL_Username guestDebugFlag_Authentication OffDebugFlag_DBMySQL OffDebugFlag_Enum OffDebugFlag_Gktmp OffDebugFlag_GktmpAPI OffDebugFlag_NumExpand OffDebugFlag_Parser OffDebugFlag_RAS OffDebugFlag_RPMS OffDebugFlag_Radius OffDebugFlag_RasAPI OffDebugFlag_Registry OffDebugFlag_Routing Off

56Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 57: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

DebugFlag_SipTcp OffDebugFlag_SipTls OffDebugFlag_StateMachine OffDeny <table></table>DiffServValue 0x00DiversionHeaderName CC-DiversionErrorLog logs/error_logFarmLabel DefaultsGktmpConnection OffGktmpTransportType UDPGroupId cspsHostnameLookups OffListen <table></table>LogFormat <table><row><format>"%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\""</format><nickname>combined</nickname></row><row><format>"%h %l %u %t \"%r\" %>s %b"</format><nickname>common</nickname></row><row><format>"%{Referer}i -> %U"</format><nickname>referer</nickname></row><row><format>"%{User-agent}i"</format><nickname>agent</nickname></row></table>LogLevel warnMasterServerHostname server1.yourdomain.comMasterServerIpAddress 192.0.0.1MasterServerPort 8250MaxClients 20MaxForks 5MaxInviteRetxCount 6MaxNonInviteRetxCount 10MaxRequestsPerChild 0MaxSpareServers 10MinSpareServers 5NumExp <table></table>NumExpandAuthUserName OnNumericUsernameCharacterSet +0123456789.-()#NumericUsernameInterpretation E164_IPOrigUserNameSource AuthPidFile logs/sipd.pidPreAuthPreviousHop <table><row><from>192.0.0.1</from></row><row><from>cisco.com</from></row><row><from>10.22.77.9</from></row></table>PreAuthRequestType QueryPreAuthorization OffPrimaryRadiusAcctIp 192.0.0.1PrimaryRadiusAcctPort 0PrimaryRadiusAcctSecret passwordPrimaryRadiusAuthIp 192.0.0.1PrimaryRadiusAuthPort 0PrimaryRadiusAuthSecret passwordProxyDomain sip.comRASAcceptLCF BESTRASAllowTranslation OnRASDefaultTechPrefixAction STRIPRASGatekeeperCluster <table></table>RASLRQMethod SEQUENTIALRASLRQWindow 3000RASModule OffRASTechPrefix <table></table>RASTimeToLive 6RASTimeoutInterval 300RASTransportType UDPRPMS_ServerIpPortSecret <table><row><IP>192.0.0.1</IP><port>1812</port><secret>testing123</secret></row><row><IP>192.0.0.1</IP><port>0</port><secret>password</secret></row></table>RadiusAuthSkew 30RadiusRetransmissionAfterFailure 0RadiusRetransmissionCount 2

57Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 58: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

RadiusRetransmissionInterval 2000RadiusRetryTime 300RadiusUserNameAttrAddDomain OffRecursive OnRegistryCleanupRate 180000ScoreBoardFile logs/apache_runtime_statusSecondaryRadiusAcctIp 192.0.0.1SecondaryRadiusAcctPort 0SecondaryRadiusAcctSecret passwordSecondaryRadiusAuthIp 192.0.0.1SecondaryRadiusAuthPort 0SecondaryRadiusAuthSecret passwordSecondaryServerHostname server2.yourdomain.comSecondaryServerIpAddress 192.0.0.1SecondaryServerPort 8250ServerRoot /opt/sipServerType ProxySharedMemorySize 128000000SipMaxT3InMs 180000SipResolveLocalContactsInRedirectMode OffSipRouteHdrTransportType UDPSipStatsInterval 3600SipStatsLog OnSipT1InMs 500SipT2InMs 4000SipT3InMs 60000SipT4InMs 32000Sip_Services_Port 52931Sip_Token_Port 22794SrvForFqdnOnly OffStartServers 5StatefulServer OnUseCallerPreferences OnUser cspsVirtualProxyHost <table></table>

SQLCommand: UPDATE CSPS SET Accounting = 'Off', AccountingClientSide = 'Off', AccountingRecordFormat = 'Radius', AccountingServerSide = 'On', AccountingTimeFormat = 'GMT', AccountingUnsuccessful = 'Off', AcctIncludeSIPHeader = '<table></table>', AddDiversionHeader = 'On', AddRecordRoute = 'Off', Allow = '<table></table>', AuthAllow3rdPartyInvite = 'On', AuthAllow3rdPartyRegistration = 'On', AuthConsumeProxyAuth = 'On', AuthDigestAlgorithm = 'MD5', AuthDigestQop = 'auth', AuthIncludeSIPHeader = '<table></table>', AuthRealm = 'CISCO', AuthScheme = 'HTTP_Digest', AuthServer = 'Proxy', Authentication = 'Off', CallForwardBusy = 'Off', CallForwardNoAnswer = 'Off', CallForwardNoAnswerTimer = '24000', CallForwardUnavailable = 'Off', CallForwardUnavailableTimer = '24000', CallForwardUnconditional = 'Off', Cisco_Enum = 'Off', Cisco_Enum_Global_Domain = 'e164.arpa.', Cisco_Numexpand = 'On', Cisco_Registry = 'On', Cisco_Registry_Max_DB_Age_on_Boot = '86400', Cisco_Registry_Remote_Update_Port = '22931', Cisco_Registry_Rendezvous_Name = 'registry_db', Cisco_Registry_Shared_Memory_Address = '0x30000000', Cisco_Registry_Use_Virtual_Proxy_Host = 'Off', Cisco_Routing = 'On', Cisco_Routing_Global_Less_Specific_Route_Search = 'Off', Cisco_Routing_Max_DB_Age_on_Boot = '86400', Cisco_Routing_Remote_Update_Port = '22913', Cisco_Routing_Rendezvous_Name = 'routing_db', Cisco_Routing_Shared_Memory_Address = '0x35000000', Cisco_Routing_Wildcard_Expand_Length = '25', CustomLog = '<table><row><file>logs/access_log</file><name>common</name></row></table>', DB_MySQL = 'On', DB_MySQL_Connect_Timeout = '1', DB_MySQL_DB = 'sip', DB_MySQL_Dest_URL_CFB_Field = 'dest_url_cfb', DB_MySQL_Dest_URL_CFNA_Field = 'dest_url_cfna', DB_MySQL_Dest_URL_CFUNC_Field = 'dest_url_cfunc', DB_MySQL_Dest_URL_CFUNV_Field = 'dest_url_cfunv', DB_MySQL_DomainName_Field = 'domain_name', DB_MySQL_FirstName_Field = 'first_name', DB_MySQL_HostName = '67.1.100.64', DB_MySQL_LastName_Field = 'last_name', DB_MySQL_MiddleName_Field = 'middle_name', DB_MySQL_Password = 'nobody', DB_MySQL_Password_Field = 'password', DB_MySQL_Secondary_HostName = '67.1.100.65', DB_MySQL_Subscriber_Table = 'subscriber', DB_MySQL_UserId_Field = 'user_id', DB_MySQL_Username = 'guest', DebugFlag_Authentication = 'Off', DebugFlag_DBMySQL = 'Off',

58Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 59: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

DebugFlag_Enum = 'Off', DebugFlag_Gktmp = 'Off', DebugFlag_GktmpAPI = 'Off', DebugFlag_NumExpand = 'Off', DebugFlag_Parser = 'Off', DebugFlag_RAS = 'Off', DebugFlag_RPMS = 'Off', DebugFlag_Radius = 'Off', DebugFlag_RasAPI = 'Off', DebugFlag_Registry = 'Off', DebugFlag_Routing = 'Off', DebugFlag_SipTcp = 'Off', DebugFlag_SipTls = 'Off', DebugFlag_StateMachine = 'Off', Deny = '<table></table>', DiffServValue = '0x00', DiversionHeaderName = 'CC-Diversion', ErrorLog = 'logs/error_log', FarmLabel = 'Defaults', GktmpConnection = 'Off', GktmpTransportType = 'UDP', GroupId = 'csps', HostnameLookups = 'Off', Listen = '<table></table>', LogFormat = '<table><row><format>\"%h %l %u %t \\\"%r\\\" %>s %b \\\"%{Referer}i\\\" \\\"%{User-Agent}i\\\"\"</format><nickname>combined</nickname></row><row><format>\"%h %l %u %t \\\"%r\\\" %>s %b\"</format><nickname>common</nickname></row><row><format>\"%{Referer}i -> %U\"</format><nickname>referer</nickname></row><row><format>\"%{User-agent}i\"</format><nickname>agent</nickname></row></table>', LogLevel = 'warn', MasterServerHostname = 'server1.yourdomain.com', MasterServerIpAddress = '127.0.0.1', MasterServerPort = '8250', MaxClients = '20', MaxForks = '5', MaxInviteRetxCount = '6', MaxNonInviteRetxCount = '10', MaxRequestsPerChild = '0', MaxSpareServers = '10', MinSpareServers = '5', NumExp = '<table></table>', NumExpandAuthUserName = 'On', NumericUsernameCharacterSet = '+0123456789.-()#', NumericUsernameInterpretation = 'E164_IP', OrigUserNameSource = 'Auth', PidFile = 'logs/sipd.pid', PreAuthPreviousHop = '<table><row><from>127.0.0.1</from></row><row><from>cisco.com</from></row><row><from>10.22.77.9</from></row></table>', PreAuthRequestType = 'Query', PreAuthorization = 'Off', PrimaryRadiusAcctIp = '127.0.0.1', PrimaryRadiusAcctPort = '0', PrimaryRadiusAcctSecret = 'password', PrimaryRadiusAuthIp = '127.0.0.1', PrimaryRadiusAuthPort = '0', PrimaryRadiusAuthSecret = 'password', ProxyDomain = 'sip.com', RASAcceptLCF = 'BEST', RASAllowTranslation = 'On', RASDefaultTechPrefixAction = 'STRIP', RASGatekeeperCluster = '<table></table>', RASLRQMethod = 'SEQUENTIAL', RASLRQWindow = '3000', RASModule = 'Off', RASTechPrefix = '<table></table>', RASTimeToLive = '6', RASTimeoutInterval = '300', RASTransportType = 'UDP', RPMS_ServerIpPortSecret = '<table><row><IP>127.0.0.1</IP><port>1812</port><secret>testing123</secret></row><row><IP>127.0.0.1</IP><port>0</port><secret>password</secret></row></table>', RadiusAuthSkew = '30', RadiusRetransmissionAfterFailure = '0', RadiusRetransmissionCount = '2', RadiusRetransmissionInterval = '2000', RadiusRetryTime = '300', RadiusUserNameAttrAddDomain = 'Off', Recursive = 'On', RegistryCleanupRate = '180000', ScoreBoardFile = 'logs/apache_runtime_status', SecondaryRadiusAcctIp = '127.0.0.1', SecondaryRadiusAcctPort = '0', SecondaryRadiusAcctSecret = 'password', SecondaryRadiusAuthIp = '127.0.0.1', SecondaryRadiusAuthPort = '0', SecondaryRadiusAuthSecret = 'password', SecondaryServerHostname = 'server2.yourdomain.com', SecondaryServerIpAddress = '127.0.0.1', SecondaryServerPort = '8250', ServerRoot = '/opt/sip', ServerType = 'Proxy', SharedMemorySize = '128000000', SipMaxT3InMs = '180000', SipResolveLocalContactsInRedirectMode = 'Off', SipRouteHdrTransportType = 'UDP', SipStatsInterval = '3600', SipStatsLog = 'On', SipT1InMs = '500', SipT2InMs = '4000', SipT3InMs = '60000', SipT4InMs = '32000', Sip_Services_Port = '52931', Sip_Token_Port = '22794', SrvForFqdnOnly = 'Off', StartServers = '5', StatefulServer = 'On', UseCallerPreferences = 'On', User = 'csps', VirtualProxyHost = '<table></table>' WHERE FarmLabel="Defaults"

CIAgent Install (csps_ciagent_install) ScriptRouter1:/opt/sip/ciagent# ./csps_ciagent_install

LICENSE AGREEMENT

THIS AGREEMENT IS BETWEEN YOU AND SNMP RESEARCH INTERNATIONAL, INC. (SNMP). READTHESE PROVISIONS CAREFULLY BEFORE ACCEPTING THIS AGREEMENT. IF YOU DO NOT AGREEWITH THEM, YOU SHOULD REFUSE THE AGREEMENT. A LICENSE WILL NOT BE GRANTED UNLESSYOU AGREE TO THE TERMS OF THIS AGREEMENT. BY ACCEPTING THE AGREEMENT, YOU AREAGREEING TO BE BOUND BY THESE PROVISIONS, WHICH INCLUDE A LICENSE, A LIMITEDWARRANTY, A DISCLAIMER, AND GENERAL PROVISIONS (collectively the "Agreement").

1. LICENSE

59Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 60: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

(a) In consideration of the purchase price paid by you for this product, SNMP grants to you a non-exclusive license to use this product in accordance with the provisions of this Agreement. (b) You may use this product for personal and professional use. You own the hardware and the media on which the software is provided, but SNMP retains title to and ownership of the software itself, and reserves all rights not expressly granted to you in this Agreement. (c) The software and documentation are copyrighted. You are not permitted to copy the documentation. You may make a single copy of the software for archival purposes. If you have received prior written consent from SNMP, then you may make additional copies of both the software and the documentation, up to the limit of the number of additional copies authorized by SNMP in the prior written notice of such. (d) You may not modify, adapt, translate, reverse engineer, decompile, disassemble, or create derivative works of the software. You may transfer this product to another who agrees to be bound by this Agreement, but you must transfer the hardware and all current and prior versions of both the software and documentation in your possession. (e) You have a royalty free right to deploy this product at a third party site on the condition that you:

i. deploy the product only as a part of your products or services; ii. receive enforceable assurances that such third party will not violate any restrictions on the use of the product that are reasonably similar to all those of this Agreement; iii. do not use SNMP's name, logo, or trademarks to market your product or services; iv. do not remove any of SNMP's copyright notices from the product; and v. agree to indemnify, hold harmless, and defend SNMP from and against any claims or lawsuits, including attorney's fees, that arise or result from the use of such deployment.

(f) SNMP has the right to terminate this Agreement if you violate any of the the provisions herein, and you can terminate the Agreement by either destroying the hardware and all copies of both the software and the documentation or returning the hardware and all copies of both the software and the documentation to SNMP.

2. LIMITED WARRANTY

(a) SNMP warrants that the media of this product shall remain free from defects in material and workmanship under normal use for a period of ninety days from the date of purchase. SNMP warrants that the product shall meet SNMP's specifications, which are available from SNMP upon request, for a period of one year from the date of purchase. The unmodified original receipt is required evidence of the date of purchase to receive benefits under this warranty. In the event of such failure within the warranty periods, SNMP shall repair, replace, or refund the purchase price of the product, at its sole option. Inaccuracies and typographical errors in the documentation are not considered defects. (b) These benefits are your sole and exclusive remedies. To receive these benefits the product must be sent postage prepaid, with any and all third party programs or hardware removed to SNMP Research International, Inc., 3001 Kimberlin Heights Road, Knoxville, Tennessee, 37920, or to such other address as SNMP may designate for such purpose from time to time. Products sent without the original SNMP accessories, including hardware, software, or documentation, may be returned without such. Replacement parts assume the remaining warranty of the parts they replace. (c) This limited warranty is redeemable only by the original purchaser, and only if the product was purchased from SNMP for the use of the original purchaser, and not for resale. This warranty covers defects occurring during the normal use of this product and does not apply when the

60Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 61: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

product:

i. Is used in a device for which it was not designed. ii. Is damaged due to physical abuse, mishandling, accident, negli- gence, another device, or failure to follow operating instructions. iii. Is modified in any manner, including, but not limited to tempes- tizing, ruggedizing, or militarizing. iv. Is damaged by the use of unauthorized parts or service. v. Has had its serial numbers altered or removed. vi. Is damaged due to improper packaging during a warranty return to SNMP.

(d) This warranty is valid only for products purchased and used in the United States, Canada, or Puerto Rico. (e) SNMP'S TOTAL LIABILITY UNDER THIS WARRANTY IS LIMITED TO THE AMOUNT OF THE PURCHASE PRICE ACTUALLY PAID.

3. DISCLAIMER

(a) EXCEPT AS EXPRESSLY SET FORTH BELOW, THE PRODUCT IS PROVIDED "AS IS," AND SNMP MAKES NO OTHER REPRESENTATIONS OR WARRANTIES, EXPRESSED OR IMPLIED. BY WAY OF EXAMPLE AND NOT LIMITATION, SNMP MAKES NO REPRE- SENTATIONS OR WARRANTIES OF MERCHANTABILITY, FITNESS FOR ANY PARTICULAR PURPOSE, ELECTRONIC SECURITY, OR FREEDOM FROM INFRINGMENT, OR THAT THE PRODUCT IS ERROR FREE OR THAT ITS USE SHALL BE UNINTERRUPTED. (b) SNMP SHALL NOT BE LIABLE FOR ANY SPECIAL DAMAGES, INDIRECT DAMAGES, PUNITIVE DAMAGES, INCIDENTAL DAMAGES, CONSEQUENTIAL DAMAGES, OR ANY DAMAGES RESULTING FROM LOSS OF USE, LOSS OF DATA, LOSS OF PROFITS, OR LOSS OF USE OF PRODUCTS, REGARDLESS OF WHETHER THE ACTION IS BASED ON WARRANTY, CONTRACT, NEGLIGENCE, OTHER TORT, OR ANY OTHER CAUSE OF ACTION, EVEN IF SNMP HAS BEEN ADVISED OF THE POSSIBIBLITY OF SUCH DAMAGE. (c) Some states do not allow the exclusion or limitation of incidental or consequential damages or of implied warranties, so some of the foregoing provisions may not apply to you. IN SUCH CASE SNMP's LIABILITY SHALL BE LIMITED TO A REFUND OF THE PRODUCT'S PURCHASE PRICE. This warranty gives you specific legal rights, and you may also have other rights which vary from state to state.

4. GENERAL PROVISIONS

(a) This Agreement is the complete and exclusive statement between you and SNMP relating to the product. (b) Any updates which SNMP may send to you from time to time, with or with- out charge, are also licensed to you under this Agreement. (c) This Agreement shall be interpreted under the laws of the State of Tennessee without regard to its choice of law statutes, with juris- diction and venue exclusively in Knox County Tennessee. (d) Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in FAR 52.227-19(c)(1,2). The rights of government sublicensees are further defined in DFARS 252.227-7202 and other corresponding governmental regulations. Contractor/manufacturer is SNMP Research International, Inc., 3001 Kimberlin Heights Road, Knoxville, TN 37920. (e) Should you have any questions concerning this Agreement, or if you wish to contact us for any reason, please call: 865.579.3311, fax: 865.579.6565, or write: SNMP Research International, Inc., 3001 Kim- berlin Heights Road, Knoxville, TN 37920.Do you accept the terms of this license? [y|n] yInstalling CIAgent...Starting CIAgent.SNMP Research BRASS Server/Subagent Version 15.3.1.24CCopyright 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 SNMP Research, Inc.

61Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 62: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

SNMP Research SNMP Agent Resident Module Version 15.3.1.24CCopyright 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 SNMP Research, Inc.SNMP Research Critical Application Subagent Version 15.3.1.24C@(#)Copyright 1992-2002 SNMP Research, IncorporatedMerging snmpinfo.datSuccessfully merged >/usr/local/ciagent/config/mgr/snmpinfo.dat<Stopping CIAgent for customization ...Customizing CIAgent ...CIAgent installation path is: /usr/local/ciagentCSPS installation path is: /usr/local/sipStarting CIAgent ...SNMP Research BRASS Server/Subagent Version 15.3.1.24CCopyright 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 SNMP Research, Inc.SNMP Research SNMP Agent Resident Module Version 15.3.1.24CCopyright 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 SNMP Research, Inc.SNMP Research Critical Application Subagent Version 15.3.1.24C@(#)Copyright 1992-2002 SNMP Research, Incorporatedrun smPopScript ...#!/bin/sh -v## Copyright (C) 1992-2000 by SNMP Research, Incorporated.## Function: This is a UNIX (TM) shell script that populates the# DISMAN-SCRIPT-MIB with a sample/demo. The sample/demo# script is written in the Mid-Level Manager scripting# language from SNMP Research, Inc.## Notes: This UNIX (TM) shell script requires the setany command-line# utility from SNMP Research.## The Mid-Level Manager script is:## exec("HelloWorld.scr");# return("Finished");## Set the DNS name of where the SNMP agent runs, the SNMP version to use,# and the SNMPv1/SNMPv2c community string or SNMPv3 usernames/auth key/# priv key to use for the SNMP set requests.#Agent="localhost"Version="-v2c"User="cspsAdmin"AuthPassword=""PrivPassword=""## Set the script owner and name strings. The SOwnerTxt and# SNameTxt shell variables are the text-name representations# of SOwner and SName. These are required because the launch# "button" in the smLaunchTable refers to the scripts in the# smScriptTable.#SOwner="10.65"SName="10.66"SOwnerTxt="A"SNameTxt="B"## Set the launch owner and name strings.#LOwner="10.67"LName="10.68"#

62Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 63: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

# Put the SNMPv3 auth/priv keys in UNIX (TM) environment variables# so that the setany utility will not prompt the user for these.#SR_UTIL_AUTH_PASSWORD=$AuthPasswordSR_UTIL_PRIV_PASSWORD=$PrivPasswordexport SR_UTIL_AUTH_PASSWORDexport SR_UTIL_PRIV_PASSWORD## Abort the execution of any existing, running, copies of this# DISMAN-SCRIPT-MIB script. Then disable the script's admin# status, then destroy an existing, possibly conflicting, row# in the directory of scripts.#setany $Version $Agent $User \ smLaunchControl.$LOwner.$LName abortsmLaunchControl.10.67.1.68 = abort(1)setany $Version $Agent $User \ smScriptAdminStatus.$SOwner.$SName disabledsmScriptAdminStatus.10.65.1.66 = disabled(2)setany $Version $Agent $User \ smScriptRowStatus.$SOwner.$SName destroysmScriptRowStatus.10.65.1.66 = destroy(6)## Create a new entry in the directory of scripts (the smScriptTable).#setany $Version $Agent $User \ smScriptRowStatus.$SOwner.$SName createAndGo \ smScriptDescr.$SOwner.$SName -D "Run a UNIX shell command." \ smScriptAdminStatus.$SOwner.$SName editing \ smScriptStorageType.$SOwner.$SName nonVolatilesmScriptRowStatus.10.65.1.66 = createAndGo(4)smScriptDescr.10.65.1.66 = Run a UNIX shell command.smScriptAdminStatus.10.65.1.66 = editing(3)smScriptStorageType.10.65.1.66 = nonVolatile(3)## Delete an existing, possibly conflicting, script from the smCodeTable.#setany $Version $Agent $User \ smCodeRowStatus.$SOwner.$SName.1 destroy \ smCodeRowStatus.$SOwner.$SName.2 destroysmCodeRowStatus.10.65.1.66.1 = destroy(6)smCodeRowStatus.10.65.1.66.2 = destroy(6)## Put the lines of the new script into the smCodeTable. Note that there# are extra characters in the script lines shown below. These are necess-# ary to resolve problems with quoted strings in UNIX (TM) shell scripts.#setany $Version $Agent $User \ smCodeRowStatus.$SOwner.$SName.1 createAndGo \ smCodeText.$SOwner.$SName.1 -D "exec(\"/usr/local/sip/bin/sip graceful\");" \ smCodeRowStatus.$SOwner.$SName.2 createAndGo \ smCodeText.$SOwner.$SName.2 -D "return(\"Finished\");"smCodeRowStatus.10.65.1.66.1 = createAndGo(4)smCodeText.10.65.1.66.1 = exec("/usr/local/sip/bin/sip graceful");smCodeRowStatus.10.65.1.66.2 = createAndGo(4)smCodeText.10.65.1.66.2 = return("Finished");## In the smScriptTable, enable the script so we can create a# launch "pushbutton" in the smLaunchTable.#setany $Version $Agent $User \ smScriptAdminStatus.$SOwner.$SName enabledsmScriptAdminStatus.10.65.1.66 = enabled(1)#

63Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 64: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Script Examples

# Destroy an existing, possibly conflicting, launch "pushbutton"# (smLaunchEntry).#setany $Version $Agent $User \ smLaunchRowStatus.$LOwner.$LName destroysmLaunchRowStatus.10.67.1.68 = destroy(6)## Create the new launch "pushButton" (smLaunchEntry). The smLaunch-# Argument MIB object specifies the arguments to the MLM script that# are used when the MLM script is run.#setany $Version $Agent $User \ smLaunchRowStatus.$LOwner.$LName createAndGo \ smLaunchScriptOwner.$LOwner.$LName -D $SOwnerTxt \ smLaunchScriptName.$LOwner.$LName -D $SNameTxt \ smLaunchArgument.$LOwner.$LName -D "sysUpTime.0 300" \ smLaunchMaxRunning.$LOwner.$LName 100 \ smLaunchMaxCompleted.$LOwner.$LName 1000 \ smLaunchStorageType.$LOwner.$LName nonVolatile \ smLaunchAdminStatus.$LOwner.$LName enabledsmLaunchRowStatus.10.67.1.68 = createAndGo(4)smLaunchScriptOwner.10.67.1.68 = AsmLaunchScriptName.10.67.1.68 = BsmLaunchArgument.10.67.1.68 = sysUpTime.0 300smLaunchMaxRunning.10.67.1.68 = 100smLaunchMaxCompleted.10.67.1.68 = 1000smLaunchStorageType.10.67.1.68 = nonVolatile(3)smLaunchAdminStatus.10.67.1.68 = enabled(1)## Launch the script by pressing the launch "pushbutton". Specifying# an integer value of 0 lets the agent compute the execution instance.## setany $Version $Agent $User \# smLaunchStart.$LOwner.$LName 0

CIAgent has been installed and is currently running.

64Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 65: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Additional References

Additional ReferencesFor additional information related to the Cisco SIP proxy server, refer to the following references:

Documents

Related Topic Document Title

Cisco SIP proxy server installation and configuration

• Cisco SIP Proxy Server Administrator Guide, Version 2.1 at http://www.cisco.com/en/US/products/sw/voicesw/ps2157/prod_technical_documentation.html

• Cisco SIP Proxy Server Installation Guide, Version 2.1 at http://www.cisco.com/en/US/products/sw/voicesw/ps2157/prod_technical_documentation.html

• Release Notes for the Cisco SIP Proxy Server Version 2.1 at http://www.cisco.com/en/US/products/sw/voicesw/ps2157/prod_technical_documentation.html

Technologies referenced within Cisco SPS software and documentation

• ADAPTIVE Communication Environment at http://www.cs.wustl.edu/~schmidt/ACE.html

• Apache Software Foundation at http://www.apache.org

• Linux FreeS/WAN at http://www.freeswan.org/

• Linux Online at http://www.linux.org

• MySQL at http://www.mysql.com

• OpenSSL at http://www.openssl.org/

• Red Hat at http://www.redhat.com

• Sun Solaris Data Encryption website: http://wwws.sun.com/software/solaris/encryption/

• Sun Microsystems at http://www.sun.com

• Sun ONE Software at http://wwws.sun.com

Sun Solaris installation information • Cisco Media Gateway Controller Software Release 9 Installation and Configuration Guide, at http://www.cisco.com/univercd/cc/td/doc/product/access/sc/rel9/swinstl/

65Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 66: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Additional References

Standards

MIBs

RFCs

Standards1

1. Not all supported standards are listed.

Title

AES Advanced Encryption Standard (AES) Ciphersuites for Transport Layer Security (TLS), RFC 3268, June 2002

HTTP Hypertext Transfer Protocol -- HTTP/1.1, RFC 2616, June 1999

SIP SIP: Session Initiation Protocol, draft-ietf-sip-rfc2543bis-04.txt

STUN Simple Traversal of UDP Through NATs (STUN), draft-ietf-midcom-stun-02.txt

TLS The TLS Protocol Version 1.0, RFC 2246, January 1999

TURN Traversal Using Relay NAT (TURN), draft-rosenberg-midcom-turn-01.txt

MIBs1

1. Not all supported MIBs are listed.

MIBs Link

• CRITAPP-MIB (critagt)

• HOST-RESOURCES-MIB (hostagt)

• SYSAPPL-MIB (sappagt)

• DISMAN-EVENT-MIB (eventagt)

• DR-WEB-CUSTOM-PAGE-MIB (htmlagt)

• LOG-MIB (logagt)

• DISMAN-SCRIPT-MIB (smagt)

• RFC1213-MIB (mibsagt)

To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL:

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

RFCs1

1. Not all supported RFCs are listed.

Title

2543 SIP: Session Initiation Protocol (March 1999)

3261 SIP: Session Initiation Protocol (June 2002)

3263 SIP: Locating SIP Servers (June 2002)

66Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 67: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Additional References

Obtaining DocumentationCisco provides several ways to obtain documentation, technical assistance, and other technical resources. These sections explain how to obtain technical information from Cisco Systems.

Cisco.com

You can access the most current Cisco documentation on the World Wide Web at this URL:

http://www.cisco.com/univercd/home/home.htm

You can access the Cisco website at this URL:

http://www.cisco.com

International Cisco websites can be accessed from this URL:

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

Documentation CD-ROM

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

Registered Cisco.com users can order a single Documentation CD-ROM (product number DOC-CONDOCCD=) through the Cisco Ordering tool:

http://www.cisco.com/en/US/partner/ordering/ordering_place_order_ordering_tool_launch.html

All users can order monthly or quarterly subscriptions through the online Subscription Store:

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

Ordering Documentation

You can find instructions for ordering documentation at this URL:

http://www.cisco.com/univercd/cc/td/doc/es_inpck/pdi.htm

You can order Cisco documentation in these ways:

• Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from the Networking Products MarketPlace:

http://www.cisco.com/en/US/partner/ordering/index.shtml

• Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco Systems Corporate Headquarters (California, U.S.A.) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).

Documentation Feedback

You can submit comments electronically on Cisco.com. On the Cisco Documentation home page, click Feedback at the top of the page.

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

67Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 68: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Additional References

You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address:

Cisco SystemsAttn: Customer Document Ordering170 West Tasman DriveSan Jose, CA 95134-9883

We appreciate your comments.

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

Cisco.com

Cisco.com offers a suite of interactive, networked services that let you access Cisco information, networking solutions, services, programs, and resources at any time, from anywhere in the world.

Cisco.com provides a broad range of features and services to help you with these tasks:

• 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

To obtain customized information and service, you can self-register on Cisco.com at this URL:

http://tools.cisco.com/RPF/register/register.do

Technical Assistance Center

The Cisco TAC is available to all customers who need technical assistance with a Cisco product, technology, or solution. Two types of support are available: the Cisco TAC website and the Cisco TAC Escalation Center. The type of support that you choose depends on the priority of the problem and the conditions stated in service contracts, when applicable.

We categorize Cisco TAC inquiries according to urgency:

• Priority level 4 (P4)—You need information or assistance concerning Cisco product capabilities, product installation, or basic product configuration. There is little or no impact to your business operations.

• Priority level 3 (P3)—Operational performance of the network is impaired, but most business operations remain functional. You and Cisco are willing to commit resources during normal business hours to restore service to satisfactory levels.

• Priority level 2 (P2)—Operation of an existing network is severely degraded, or significant aspects of your business operations are negatively impacted by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation.

68Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 69: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Additional References

• Priority level 1 (P1)—An existing network is “down,” or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation.

Cisco TAC Website

The Cisco TAC website provides online documents and tools to help troubleshoot and resolve technical issues with Cisco products and technologies. To access the Cisco TAC website, go to this URL:

http://www.cisco.com/tac

All customers, partners, and resellers who have a valid Cisco service contract have complete access to the technical support resources on the Cisco TAC website. Some services on the Cisco TAC website require 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 this URL to register:

http://tools.cisco.com/RPF/register/register.do

If you are a Cisco.com registered user, and you cannot resolve your technical issues by using the Cisco TAC website, you can open a case online at this URL:

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

If you have Internet access, open P3 and P4 cases online so that you can fully describe the situation and attach any necessary files.

Cisco TAC Escalation Center

The Cisco TAC Escalation Center addresses priority level 1 or priority level 2 issues. 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 automatically opens a case.

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

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

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

Obtaining Additional Publications and InformationInformation about Cisco products, technologies, and network solutions is available from various online and printed sources.

• The Cisco Product Catalog describes the networking products offered by Cisco Systems, as well as ordering and customer support services. Access the Cisco Product Catalog at this URL:

http://www.cisco.com/en/US/products/products_catalog_links_launch.html

• Cisco Press publishes a wide range of networking publications. Cisco suggests these titles for new and experienced users: Internetworking Terms and Acronyms Dictionary, Internetworking Technology Handbook, Internetworking Troubleshooting Guide, and the Internetworking Design Guide. For current Cisco Press titles and other information, go to Cisco Press online at this URL:

http://www.ciscopress.com

69Cisco SIP Proxy Server Installation Guide

78-15951-01

Page 70: Cisco SIP Proxy Server Installation Guide Version 2 · Cisco SIP Proxy Server Installation Guide Version 2.1 Prerequisites 3 Cisco SIP Proxy Server Installation Guide 78-15951-01

Cisco SIP Proxy Server Installation Guide Version 2.1Additional References

• Packet magazine is the Cisco quarterly publication that provides the latest networking trends, technology breakthroughs, and Cisco products and solutions to help industry professionals get the most from their networking investment. Included are networking deployment and troubleshooting tips, configuration examples, customer case studies, tutorials and training, certification information, and links to numerous in-depth online resources. You can access Packet magazine at this URL:

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

• iQ Magazine is the Cisco bimonthly publication that delivers the latest information about Internet business strategies for executives. You can access iQ Magazine at this URL:

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

• Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in designing, developing, and operating public and private internets and intranets. You can access the Internet Protocol Journal at this URL:

http://www.cisco.com/en/US/about/ac123/ac147/about_cisco_the_internet_protocol_journal.html

• Training—Cisco offers world-class networking training. Current offerings in network training are listed at this URL:

http://www.cisco.com/en/US/learning/le31/learning_recommended_training_list.html

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

CCIP, CCSP, the Cisco Arrow logo, the Cisco Powered Network mark, Cisco Unity, Follow Me Browsing, FormShare, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Aironet, ASIST, BPX, Catalyst, CCDA, CCDP, CCIE, CCNA, CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, the Cisco IOS logo, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Empowering the Internet Generation, Enterprise/Solver, EtherChannel, EtherSwitch, Fast Step, GigaStack, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, LightStream, MGX, MICA, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, RateMUX, Registrar, ScriptShare, SlideCast, SMARTnet, StrataView Plus, Stratm, SwitchProbe, TeleRouter, The Fastest Way to Increase Your Internet Quotient, TransPath, and VCO are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and certain other countries.

All other trademarks mentioned in this document or Web site 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. (0304R)

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

70Cisco SIP Proxy Server Installation Guide

78-15951-01