Table Of Contents
Installing the Collection Manager
Introduction
System Requirements
Checking System Prerequisites
Solaris Requirements
Hardware
Software and Environment
Setting the Locale and Time Zone
Red Hat Linux Requirements
Hardware
Software and Environment
Setting the Locale and Time Zone
Distribution Content
Default Configuration Settings
How to Install the Collection Manager
Ports Used by the Collection Manager Software
Installing the Sybase Database
Actions Performed by installsyb.sh
Prerequisites
Installing Collection Manager Software
Information About the install-cm.sh Script
How to Uninstall the Sybase Database and Collection Manager Software
Uninstalling Sybase
Uninstalling the Collection Manager Software
Upgrading the Collection Manager to Version 3.5.x
Installing the Collection Manager
Revised: February 15, 2011, OL-7208-12
Introduction
This chapter describes the procedures for installing the collection manager (CM) and its database, and explains how to run the collection manager.
Note 
For typical installation and configuration, use the Cisco Service Control Management Suite Collection Manager Quick Start Guide.
•System Requirements
•How to Install the Collection Manager
•How to Uninstall the Sybase Database and Collection Manager Software
•Upgrading the Collection Manager to Version 3.5.x
System Requirements
The CM and its database are software components that run on a server platform. They can be installed on any of the following configurations:
•Sun SPARC machine (64-bit) running 64-bit versions of Solaris 9 or Solaris 10. (See Solaris Requirements)
•Intel machine (32-bit or 64-bit) running 32-bit versions of Red Hat Enterprise Linux 4.0 or Red Hat Enterprise Linux 5.0 or 64-bit versions of Red Hat Enterprise Linux 5. (See Red Hat Linux Requirements)
All configurations use a 32-bit Java virtual machine (JVM).
Caution The CM must run on its own machine. You cannot run it on the same machine as the Subscriber Manager and/or other applications.
Note When using the bundled Sybase database, the server on which you install the CM can have a maximum of 4 CPU cores.
•Checking System Prerequisites
•Solaris Requirements
•Red Hat Linux Requirements
•Distribution Content
•Default Configuration Settings
Checking System Prerequisites
The CM distribution contains a script, check_prerequisites.sh, located in the install_scripts directory. The script helps to determine if a system meets the requirements for installing a CM or the bundled Sybase database.
The script checks overall readiness of the system for a CM or Sybase installation. The main prerequisites checked are:
•CPU speed
•Amount of RAM
•Operating System version (Solaris 9 or 10, Red Hat Enterprise Linux 4 or 5)
•Additional required and optional packages
•Python installed and executable in path
•Free space for CM and Sybase homes
•Names for all network interface cards (NICs)
•Sybase kernel parameters
•Locale and time zone formats
check_prerequisites.sh [ --sybhome=SYBHOME ] [ --cmhome=CMHOME ] [ --datadir=DATADIR ]
Table 3-1 check_prerequisites.sh Script Options
|
Intended home directory for Sybase installation
|
|
Intended data directory for Sybase data files (for the Datadir installation method)
|
|
Intended home directory for CM installation
|
Solaris Requirements
Collection Manager Release 3.1.0 or later can be installed on any Sun SPARC Machine running Solaris that conforms to the requirements listed in the following sections.
•Hardware
•Software and Environment
•Setting the Locale and Time Zone
Hardware
•Minimum 500 MHz CPU
•Minimum 1 GB RAM per CPU
•Hard disk:
–One hard disk, at least 18 GB
–(Recommended for bundled installations) A second hard disk (at least 18 GB), to store Sybase data
•100BASE-T network interface
Software and Environment
•Solaris Version 5.9 64-bit build 04/01 or later (currently only Solaris Version 5.9 and 5.10 are supported).
–Solaris 9—Patch level 9 is recommended
–Solaris 10—Patch level 10 is recommended
•Solaris Core Installation.
•Install the following additional packages:
system
|
SUNWbash
|
GNU Bourne-Again shell (bash)
|
system
|
SUNWgzip
|
The GNU Zip (gzip) compression utility
|
system
|
SUNWzip
|
The Info-Zip (zip) compression utility
|
system
|
SUNWlibC
|
Sun Workshop Compilers Bundled libC
|
system
|
SUNWlibCx
|
Sun WorkShop Bundled 64-bit libC
|
•If you are installing the CM in bundled mode with the Sybase database, you must install the following package:
system
|
SUNWipc
|
Interprocess Communication
|
•(Optional) The following packages may be installed (for sysadmin applications such as sys-unconfig):
system
|
SUNWadmap
|
System administration applications
|
system
|
SUNWadmc
|
System administration core libraries
|
•To use the Python scripts, a Python interpreter Version 2.2.1 or later must be present on the system. You can install the following interpreter package:
application
|
SMCpythn (Solaris 9)
SMCpython (Solaris 10)
|
Python
|
•The Python package requires the installation of two additional packages:
application
|
SMClibgcc
|
libgcc
|
application
|
SMCncurs
|
ncurses
|
•You can download these packages from http://sunfreeware.com/
The root (/) partition must have at least 104 MB of free space to install these packages.
•Apply the latest recommended patches from Sun:
–For Solaris 9, go to http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/xos-9&nav=pub-patches
–For Solaris 10, go to http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/xos-10&nav=pub-patches
–For Java, go to http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/J2SE
•If you are using Sybase, install the current Solaris patches recommended by Sybase.
•At least 8 GB free on the partition where the CM is to be installed. (This is used for CSV storage and persistent buffers.)
•(For installations with bundled Sybase) At least 3 GB free on one partition for the Sybase home directory.
•(For installations with bundled Sybase) Free space on one partition to hold the desired size of the Sybase data and logs (the sizes are configurable at install time).
•(For installations with bundled Sybase where the legacy (pre-3.0) Cisco Service Control Application Suite (SCAS) Reporter is to be used.) An FTP server should be listening on port 21 so that the SCA Reporter can authenticate against it.
•(For installations with bundled Sybase) Before installation, verify that all IP addresses that are configured for the machine NICs have hostnames associated with them in /etc/hosts or in another active naming service. (This is a limitation of Sybase Adaptive Server Enterprise.)
•(For installations with bundled Sybase) Use the set_shmmax.sh script (located under install-scripts/) to configure the kernel memory.
•Additionally, at startup you must load the IPC module by putting the following lines in the file /etc/system:
•If you are using database periodic delete, the scmscm user should be able to schedule and run cron jobs.
Setting the Locale and Time Zone
•For correct CM and Sybase operation, U.S. English locale must be used.
To set the locale, put the following line in the /etc/TIMEZONE configuration file (changes to this file require a restart to take effect):
Solaris also needs to have this locale installed. Verify that the locale is installed by checking that the directory /usr/lib/locale/en_US exists. If the directory does not exist, install the locale files from the Solaris CDs.
•Setting the OS time zone as an offset from GMT in POSIX format is not recommended, and may lead to problems. Best is to set the time zone in the /etc/TIMEZONE configuration file by (supported) country name, as in the following example.
Verify that the country name is supported as a time zone setting by checking that it is listed in the directory /usr/share/lib/zoneinfo.
If GMT offset must be used, use the zoneinfo format by prepending an :Etc/ prefix, as in the following example:
Red Hat Linux Requirements
Collection Manager Version 3.1.0 or later can be installed on any i386 running Red Hat Linux that conforms to the requirements listed in the following sections.
•Hardware
•Software and Environment
•Setting the Locale and Time Zone
Hardware
•Minimum 800 MHz CPU
•Minimum 1 GB RAM per CPU
•Hard disk:
–One hard disk, at least 18 GB
–(Recommended for bundled installations) A second hard disk (at least 18 GB), to store Sybase data
•100BASE-T network interface
Software and Environment
•Red Hat Linux 4.0.
–kernel -2.6.9-5
–glibc-2.3.4-2
–compat-libstdc++-33-3.2.3-47.3
–Minimum patch level required: Update 7
•Red Hat Linux 5.0
–kernel-2.6.18-8.el5
–glibc-2.5-12
–compat-libstdc++-33-3.2-61
–Minimum patch level required: Update 5.3
•Red Hat Enterprise "Base" Installation.
•(For installations with bundled Sybase) Install the following additional package:
–compat-libstdc++
•This package is available on the Red Hat installation CD.
•Apply latest recommended patches from Red Hat.
•(For installations with bundled Sybase) Install current patches recommended by Sybase.
•Reserve at least 8 GB free on the partition where the CM is to be installed. (This is used for CSV storage and persistent buffers.)
•(For installations with bundled Sybase) At least 1 GB free on some partition for the Sybase home directory.
•(For installations with bundled Sybase where the legacy (pre-Version 3.0) Cisco Service Control Application Suite (SCAS) Reporter is to be used.) An FTP server should be listening on port 21 so that the SCA Reporter can authenticate against it.
•(For installations with bundled Sybase) Before installation, verify that all IP addresses that are configured for the machine NICs have hostnames associated with them in /etc/hosts or in another active naming service. (This is a limitation of Sybase Adaptive Server Enterprise.)
•(For installations with bundled Sybase) Use the set_shmmax.sh script (located under install-scripts/) to configure the kernel memory.
•If you are using database periodic delete, the scmscm user should be able to schedule and run cron jobs.
Setting the Locale and Time Zone
•For correct CM and Sybase operation, U.S. English locale (en_US) must be used.
Distribution Content
The collection manager installation kit contains installation scripts for installing the CM and the Sybase database.
It also contains:
•Scripts to support file-gathering
•Scripts for periodic Sybase maintenance
Default Configuration Settings
Settings for the CM are configured during installation. These settings include which adapters to enable and their locations, Priority Queue parameters, the target adapters for each type of RDR (by RDR tag value), and various logging policies. Only qualified personnel should change these settings.
How to Install the Collection Manager
This section describes how to install CM Version 3.1.0 or later and the Sybase database on a computer running Solaris or Red Hat Linux.
•Ports Used by the Collection Manager Software
•Installing the Sybase Database
•Installing Collection Manager Software
Ports Used by the Collection Manager Software
Table 3-2 describes the TCP/UDP ports on which the CM software and associated components (such as the Sybase database) listen. This table may help the network administrator understand the behavior of the software and its adherence to the security policy.
Table 3-2 Ports that the CM Listens on Constantly
Port Number
|
Description
|
33000
|
Used by the SCE devices to send RDRs for data collection.
|
21
|
Used by the legacy (pre-Version 3.0) SCAS Reporter to authenticate against the CM user on the CM machine.
|
33001
|
Internal collection manager.
Note Access is required only from the local machine; external access can be blocked.
|
9092
|
HTTP technician interface.
|
4100
|
(For installations with bundled Sybase) Sybase database connectivity through ODBC/JDBC. Required for access to the database.
|
1099—1120
|
RMI. Used as the management interface between the data collector and the Service Control management server.
|
22000
|
FTP server of the CM.
Note FTP transactions may listen on other ports (22001 to 22100) for data transfer, as negotiated by the protocol.
|
7787
|
Internal logging of the management user log.
Note Access is required only from the local machine; external access can be blocked.
|
14375
|
Used by the Cisco Service Control Application Suite for Broadband (SCA BB) Console to send symbol definitions (values.ini) to the CM.
|
The ports listed are those on which the device listens constantly. You should allow access on these port numbers; otherwise, certain operations may fail.
Some operations (such as file transfer) cause a device to temporarily open ports other than those listed; however, these ports close automatically when the operation ends.
Installing the Sybase Database
If you do not want to install Sybase (for example, when working in unbundled mode), go to Installing Collection Manager Software.
Note Installing the Sybase database can take up to three hours.
Note The CM with the bundled Sybase database can be installed on a server with a maximum of four CPU cores according to the Sybase license.
Note The maximum database size supported by the bundled Sybase database is 50GB. For database support larger than 50GB, use an external database.
Note During installation, if you want to reverse the Sybase installation actions (for example, if an installation is interrupted because of a power failure), do the following:
1. Log in as the root user.
2. End any Sybase processes by typing pkill -u sybase.
3. Remove the Sybase user and home directory by typing userdel -r sybase.
4. Restart the Sybase installation process from the beginning.
Actions Performed by installsyb.sh
The installsyb.sh script installs the Sybase database. The script performs the following actions:
•Verifies the shmem setting for Sybase in /etc/system (for Solaris) or /etc/sysctl.conf (for Red Hat Linux). If the setting is not there, the script inserts it and reboots (after prompting the user).
•Adds a user sybase and group sybase.
•Runs the Sybase installer for your platform.
•Builds a Sybase server including Sybase users and passwords.
•Starts Sybase.
•Runs SQL scripts to create the collection manager database structure. This is a lengthy process that involves restarting Sybase several times.
Prerequisites
Log in as the root user and make the distribution kit contents available on your system or local network.
Step 1 Change directory to sybase in the distribution kit root.
Step 2 Run the script installsyb.sh. Enter the script as follows:
installsyb.sh --sybhome=SYBHOME { --datadir=DATADIR }
•SYBHOME is the home directory of the Sybase user (and should have 1 GB free)
•Select one of the following data location options:
–Specify --datadir=DATADIR, where DATADIR is a directory in which all Sybase data is to be stored.
Use a location in a partition where at least 15 GB is free.
•If you specify a DATADIR, all Sybase data is stored as normal files in that directory, with default sizes of 10 GB for data, 3 GB for logs, and 3 GB for Sybase temporary storage. The ownership of the directory is changed to the Sybase user during installation.
•During the Sybase installation process, you need to enter the size of the Sybase database. Following message is displayed to enter the database size:
Please enter SIZE in 2K blocks of file to be used for the "data[maximum is 102657160;
minimum is 5242798]" device.
NOTE - the actual size required will include a 1.05 overhead on the amount you
specify.
SIZE in 2K blocks:
Installing Collection Manager Software
Note During the installation, if you want to reverse the Sybase installation action (for example, if an installation is interrupted because of a power failure), do the following:
1. Log in as the root user.
2. End any Sybase processes by typing pkill -u sybase.
3. Remove the Sybase user and home directory by typing userdel -r sybase.
4. Restart the Sybase installation process from the beginning.
Information About the install-cm.sh Script
Use the install-cm.sh script to install the collection manager server.
install-cm.sh Options
The usage message for the install-cm.sh script is:
Usage: install-cm.sh [-h] (-d CMDIR | -o)
Options: -d CMDIR select directory for ~scmscm
(must not exist and must be on 8 GB free partition)
-o upgrade the existing installation
while preserving the current configuration
-h print this help and exit
Description of the options:
Used to designate the directory of the newly created
scmscm user's home. Should be the name of a
non-existing directory, whose parent resides on a
partition where at least 8 GB is free.
As an alternate to this option, you can specify -o :
Use this option when you wish to upgrade the existing
installation while preserving the current configuration.
Actions Performed by install-cm.sh
The install-cm.sh script performs the following actions:
•If needed, creates an scmscm user and an scmscm group
•Optionally, creates the home for this user
•Populates the home of scmscm with CM files and scripts
•Installs the following extra component:
–private JRE in ~scmscm/cm/lib
•Creates boot script symbolic links for the sybase and scmscm users in /etc/init.d and /etc/rcX.d
Step 1 Change directory to install-scripts under the distribution kit root
Step 2 Run the install-cm.sh script
For more information about the install-cm.sh script options, see install-cm.sh Options.
For additional information about the script, see Actions Performed by install-cm.sh.
Step 3 After the script completes, set a password for the scmscm user
Run the following command to set the password for the scmscm user:
Be sure to record the password that you choose.
Step 4 Increase the amount of memory allocated to the topper/aggregator adapter
For information about calculating the topper/aggregator adapter memory, see TA Adapter Memory Requirements, page 2-5.
If you are going to run an application that uses the topper/aggregator (TA) adapter, you may need to increase the amount of memory allocated to this adapter. This depends on the number of subscribers to be managed by the CM. To increase the memory allocation:
a. Open the file ~scmscm/cm/config/cm.conf.
b. Locate the setting containing TAAdapter in the [adapter_mem] section.
c. Change the default value (512 MB) to a larger value.
For example, to allocate 1024 MB of memory, set the value to -Xmx1024M.
d. Save and close the file.
Step 5 Increase the amount of memory allocated to the real-time aggregating adapter
If you are going to run an application that uses the real-time aggregating (RAG) adapter, you may need to increase the amount of memory allocated to this adapter. This depends on the number of subscribers to be handled by the CM and on your RAG Adapter configuration. To change the setting:
a. Open the file ~scmscm/cm/config/cm.conf.
b. Locate the setting containing RAGAdapter in the [adapter_mem] section.
c. Change the default value (512 MB) to a larger value.
For example, to allocate 1024 MB of memory, set the value to -Xmx1024M.
d. Save and close the file.
Note To use an external database, you must also configure a dbpack to enable the CM to connect to the database. See Managing Databases and the Comma Separated Value Repository, page 5-1for details of how to do this.
Step 6 For each adapter that your application uses, configure the adapter to point to the application
•JDBC adapter—Edit the file ~scmscm/cm/config/jdbcadapter.conf, and, in the [app] section, change the value of app_conf_dir to point to your desired application.
By default, it is set to apps/scasbb/3.5.5.
•TA adapter—Edit the file ~scmscm/cm/config/taadapter.conf, and, in the [app] section, change the value of app_conf_dir to point to your desired application.
By default, it is set to apps/scasbb/3.5.5.
Step 7 Install and activate the periodic delete procedures for the database tables.
(For information about configuring the behavior of periodic delete, see Managing the Periodic Deletion of Old Records, page 5-4.)
Note If reports are sent to the database and you do not install and activate the periodic delete procedures, the second disk may overflow.
a. Install the periodic delete procedures
Log on as the scmscm user, start the CM, wait 1 to 2 minutes for the database tables to be created, and then run the script:
~scmscm/db_maint/create_periodic_del_procs.sh
b. Activate the automatic invocation of the periodic delete procedures
Run the following command:
~scmscm/scripts/dbperiodic.py --load
Step 8 Set the Service Control Engine (SCE) device time zone
Use the following command to set the time zone:
~scmscm/cm/bin/jselect-sce-tz.sh --offset=offset-in-minutes from GMT
For example, if the SCE device is located in GMT+2, use:
~scmscm/cm/bin/jselect-sce-tz.sh --offset=120
If the SCE is located in GMT-10, use:
~scmscm/cm/bin/jselect-sce-tz.sh --offset=-600
Note Run this script every time that the time zone of the SCE is updated; for example, when updating the time zone when moving to daylight savings time. The SCA Reporter will not use the correct time intervals unless the offset stored in the CM is consistent with the SCE's time zone.
Step 9 Start the CM by running the following command:
How to Uninstall the Sybase Database and Collection Manager Software
•Uninstalling Sybase
•Uninstalling the Collection Manager Software
Uninstalling Sybase
To uninstall the Sybase database:
Step 1 Log in as the root user
Step 2 Uninstall Sybase
Run the following commands to uninstall Sybase:
rm /etc/rc*.d/[SK]*sybase
Step 3 Edit /etc/system (for Solaris) or /etc/sysctl.conf (for Red Hat Linux) and remove the Sybase shmem setting
Uninstalling the Collection Manager Software
To uninstall the CM software:
Step 1 Log in as the root user.
Step 2 Uninstall the CM software
Run the following commands to uninstall the CM software:
rm /etc/rc*.d/[SK]*scmscm
Upgrading the Collection Manager to Version 3.5.x
To upgrade the CM to Version 3.5.x:
Step 1 Stop the CM
Step 2 Install the new CM using the install-cm.sh script.
When upgrading, use the -o option to preserve the existing configuration.
The existing scmscm user is used.
After the upgrade, when the CM comes up for the first time, the database tables that are new in Version 3.5.x are created automatically.
Note The upgrade to Version 3.5.x can only be performed from Version 3.x.x.
