Upload
pablo-puricelli
View
229
Download
0
Embed Size (px)
Citation preview
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
1/136
Americas Headquarters
Cisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAhttp://www.cisco.comTel: 408 526-4000
800 553-NETS (6387)Fax: 408 527-0883
Cisco Collection Manager User Guide
Release 3.8.x
December 21, 2012
Text Part Number: OL-26830-02
http://www.cisco.com/http://www.cisco.com/8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
2/136
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL
STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSEOR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCBs public
domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO D ATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a li st of Cisco trademarks, go to this
URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned 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. (1110R
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display
output, network topology diagrams, and other figures included i n the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in
illustrative content is unintentional and coincidental.
Cisco Collection Manager User Guide
2012 Cisco Systems, Inc. All rights reserved.
http://www.cisco.com/go/trademarkshttp://www.cisco.com/go/trademarks8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
3/136
iii
Cisco Collection Manager User Guide
OL-26830-02
C O N T E N T S
About this Guide ix
Introduction ix
Document Revision History x
Organization xi
Related Publications xii
Conventions xiii
Obtaining Documentation and Submitting a Service Request xiv
CHA P T E R 1 Cisco Service Control and Cisco Service Control Engine Overview 1-1
Introduction 1-1
Cisco Service Control Solution 1-2
Service Control for Broadband Service Providers 1-2
Cisco Service Control and SCE Capabilities 1-3
SCE Platform Description 1-4
Management and Collection 1-6
Network Management 1-6
Subscriber Management 1-7
Service Configuration Management 1-7
Data Collection 1-7
CHA P T E R 2 Collection Manager Overview 2-1
Introduction 2-1
Data Collection Process 2-2
Raw Data Records 2-3
Collection Manager Software Package 2-5
Raw Data Record Server 2-5
Categorizer 2-5
Priority Queues and Persistent Buffers 2-5
Adapter Description 2-6
JDBC Adapter 2-6
Comma-Separated Value Adapter 2-6
Custom Adapter 2-7
Topper/Aggregator (TA) Adapter 2-7
http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
4/136
Contents
iv
Cisco Collection Manager User Guide
OL-26830-02
TA Adapter Cycles 2-7
TA Adapter Memory Requirements 2-8
Real-Time Aggregating Adapter 2-9
RAG Adapter Aggregation Buckets 2-9
Flushing a Bucket 2-10
RAG Adapter Process for HTTP Transaction Usage RDR 2-10
RAG Adapter Process for Video Transaction Usage RDR 2-10
RAG Adapter Mobile Based Reports 2-10
RAG Adapter Process for Subscriber Usage RDR 2-11
Managing OSFP support for Subscriber Usage RDR 2-12
Using Databases 2-13
Using the Bundled Database 2-13
Using an External Database 2-13
CHA P T E R 3 Installing Collection Manager 3-1
Introduction 3-1
System Requirements 3-2
Checking System Prerequisites 3-2
Hardware Requirements 3-3
Solaris Requirements 3-3
Software and Environmen 3-4
Setting the Locale and Time Zone 3-5
Red Hat Linux Requirements 3-5Software and Environment 3-6
Setting the Locale and Time Zone 3-7
CentOS Linux Requirements 3-7
Distribution Content 3-7
Default Configuration Settings 3-7
How to Install Collection Manager 3-8
Getting Collection Manager Software 3-8
Collection Manager Software Ports 3-9
Installing the Bundled Sybase Database 3-9
Actions installsyb.sh Performs 3-10
Prerequisites 3-11
Installing Collection Manager Software 3-12
Information About the install-cm.sh Script 3-12
Configuring the External MySQL Server 3-16
Uninstalling the Sybase Database and Collection Manager Software 3-17
Uninstalling Sybase 3-17
http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
5/136
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
6/136
Contents
vi
Cisco Collection Manager User Guide
OL-26830-02
Common Database Management Tasks 5-2
Listing Database Tables 5-2
Managing the CM Periodic Deletion of Old Records 5-3
Configuring Periodic Delete 5-4
Applying the Periodic Delete Configuration File 5-6
Deleting a Table 5-7
Deleting Old Records 5-7
UNICODE Support for Sybase Database 5-8
Managing the Bundled Sybase Database 5-9
Backing up the Database 5-9
Updating Sybase with a Changed IP Address 5-10
Updating Sybase Database Statistics 5-10
Managing the External MySQL Database 5-11
Backing up the MySQL Database 5-11Restoring a MySQL Database 5-11
Partitioning the MySQL Database 5-11
Prerequisites 5-11
Configuring Partitioning 5-12
Managing the Oracle Database 5-14
Oracle Support with Minimum Privileges 5-14
Aggregating Database Data 5-15
Configuring Aggregation 5-16
Enabling Aggregation in Sybase 5-17Enabling Aggregation in MySQL 5-17
Enabling Aggregation in Oracle 5-17
Managing the CSV Repository 5-19
CSV Repository File Structure 5-19
Configuring the CSV File Repository 5-19
Configuring the Comma Escape 5-20
Configuring Escape of Nonprintable Characters 5-21
CHA P T E R 6 Configuring Databases 6-1
Introduction 6-1
QuickStart Guide 6-1
Generating SQL Code Using the Velocity Template Language 6-2
Database Configuration Files 6-3
Context Objects 6-4
tables Object 6-4
http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
7/136
Contents
vii
Cisco Collection Manager User Guide
OL-26830-02
dbinfo Object 6-4
tools Object 6-5
Application Configuration 6-5
Working Sample 6-6
Macro Definitions 6-6
dbinfo Configuration 6-7
SQL Definitions 6-7
Code for Dropping a Table 6-7
Code for Creating a Table 6-7
Code for Creating Indexes 6-8
Code for Insert 6-8
Code for Metadata Query 6-8
Testing and Debugging 6-9
Parsing a String 6-9Obtaining Full Debug Information 6-9
Using the JDBC Framework in Scripts 6-10
Viewing and Setting the SCE Time Zone Offset 6-10
Scalability Hints for Oracle 6-12
Using Custom Tablespaces 6-12
Using Table Partitioning 6-12
APPEND I X A Code Samples A-1
Introduction A-1
Application Configuration A-2
dbtables.xml File A-2
tables.dtd File A-3
RAG Adapter Configuration A-5
ragadapter.conf File A-5
ragadapter.xml File A-6
http_TURs.xml File A-6
video_TURs.xml File A-7
vlink_BW_per_pkg.xml File A-8
vsa_SURs.xml File A-8
cdma_SURs.xml file A-9
Custom Adapter Configuration A-9
APPEND I X B Configuration Files Descriptions B-1
Introduction B-1
http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
8/136
Contents
viii
Cisco Collection Manager User Guide
OL-26830-02
General Configuration Files B-2
Collection Manager Configuration B-2
[adapter] Section B-2
[adapter_mem] Section B-3
[adapter_start_timeout] Section B-3
[buffer] Section B-4
[queue] Section B-4
[categorizer] Section B-4
[server] Section B-5
[collector] Section B-5
[csv_adapter] Section B-5
Queue Configuration B-6
Adapter Configuration Files B-7
Topper/Aggregator (TA) Adapter B-7[config] Section B-7
[rdr] Section B-9
[csv] Section B-9
[state save] Section B-10
[db] Section B-10
[app] Section B-12
[peak_hours] Section B-12
CSV Adapter B-13
[csvadapter] Section B-13
[bench] Section B-13
JDBC Adapter B-14
[bench] Section B-14
[db] Section B-14
[app] Section B-15
RAG Adapter B-15
[config] Section B-15
[housekeeper] Section B-16
[db] Section B-16
[app] Section B-16Comma Separated Value Adapter B-17
[customadapter] Section B-17
[bench] Section B-17
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
9/136
ix
Cisco Collection Manager User Guide
OL-26830-02
About this Guide
IntroductionThis guide describes how to install and configure the Collection Manager as part of the Cisco Service
Control Management Suite (SCMS) solution.
This guide is intended for technicians who must install and configure the Collection Manager. The guideis also intended for service provider operators who must manage the daily operations of the Collection
Manager. Technicians and operators should be familiar with the Cisco Service Control Solution, Cisco
Service Control Engine (SCE) platforms, and related components.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
10/136
x
Cisco Collection Manager User Guide
OL-26830-02
About this Guide
Document Revision HistoryTable 1lists the changes to this document since it was first released.
Table 1 Document Revision History
RevisionCisco Service ControlRelease and Date Change Summary
OL-26830-02 Supports all 3.8.x releases
December 12, 2012
Updated for Release 3.8.5.
OL-26830-01 Supports all 3.8.x releases
September 17, 2012
Updated for Release 3.8.0.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
11/136
xi
Cisco Collection Manager User Guide
OL-26830-02
About this Guide
OrganizationTable 2describes the sections in this document.
Table 2 Document Organization
Section Title Description
1 Cisco Service Control and Cisco
Service Control Engine Overview
Provides a functional overview of the Cisco
Service Control solution.
2 Collection Manager Overview Describes the Collection Manager components.
3 Installing Collection Manager Describes how to install the Collection Manager
and its database, and explains how to run the
Collection Manager.
4 Chapter 4, Managing Collection
Manager
Explains how to use utility scripts to view and
update Collection Manager parameters and other
information.
5 Chapter 5, Managing Databases andthe Comma-Separated Value
Repository
Explains how to use utility scripts to manage theCollection Manager database and the CSV
repository.
6 Configuring Databases Explains how to configure the Collection
Manager to work with your database.
A Code Samples Provides sample lists of code for configuration
files.
B Configuration Files Descriptions Describes the available parameters in all of the
configuration files.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
12/136
xii
Cisco Collection Manager User Guide
OL-26830-02
About this Guide
Related PublicationsUse this guide with the following Cisco documentation:
Cisco Service Control Application for Broadband User Guide
Cisco Service Control Application for Broadband Reference Guide Cisco SCA BB Service Configuration API Programmer Guide
Cisco Service Control Application Reporter User Guide
http://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/scabbug/scabbug.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/scabbrg/scabbrg.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/scabbpg355/scabb_pg.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/reporterug/reporter.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/reporterug/reporter.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/scabbpg355/scabb_pg.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/scabbrg/scabbrg.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/scabbug/scabbug.html8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
13/136
xiii
Cisco Collection Manager User Guide
OL-26830-02
About this Guide
ConventionsTable 3presents and defines the documentation conventions used in this guide:
Note Means reader take note.
Tip Means that the following information will help you solve a problem.
Caution Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.
Timesaver Means the described action saves time. You can save time by performing the action described in
the paragraph.
Warning Means reader be warned. In this situation, you might perform an action that could result in
bodily injury.
Table 3 Conventions
Convention Indication
boldfont Commands and keywords and user-entered text appear in boldfont.
italicfont Document titles, new or emphasized terms, and arguments for which you supply
values are in italicfont.
[ ] Elements in square brackets are optional.
{x | y | z } Required alternative keywords are grouped in braces and separated by
verticalbars.
[ x | y | z ] Optional alternative keywords are grouped in brackets and separated by
verticalbars.
string A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
courierfont Terminal sessions and information the system displays appear in courierfont.
< > Nonprinting characters such as passwords are in angle brackets.
[ ] Default responses to system prompts are in square brackets.
!, # An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
14/136
xiv
Cisco Collection Manager User Guide
OL-26830-02
About this Guide
Obtaining Documentation and Submitting a Service RequestFor information on obtaining documentation, submitting a service request, and gathering additional
information, see the monthly Whats New in Cisco Product Documentation, which also lists all new and
revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to Whats New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and
set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service
and Cisco currently supports RSS version 2.0.
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.htmlhttp://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
15/136
C H A P T E R
1-1
Cisco Collection Manager User Guide
OL-26830-02
1Cisco Service Control and Cisco Service ControlEngine Overview
This chapter presents an overview of the Cisco Service Control solution operating with the Cisco Service
Control Engine (SCE). The Collection Manager uses the hardware capabilities of the Cisco SCE
platform. It identifies the combination of Cisco-specific applications that create the Cisco Service
Control solution.
Cisco Service Control Solution, page 1-2
Cisco Service Control and Cisco SCE Capabilities, page 1-3
SCE Platform Description, page 1-4
Management and Collection, page 1-6
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
16/136
1-2
Cisco Collection Manager User Guide
OL-26830-02
Chapter 1 Cisco Service Control and Cisco Service Control Engine Overview
Cisco Service Control Solution
Cisco Service Control SolutionThe Cisco Service Control solution combines hardware and software components. Service providers can
use the SCE platform to classify, analyze, and control Internet and IP traffic.
Service Control for Broadband Service Providers
TheCisco SCA BB adds a layer of service intelligence and control to existing networks that can:
Report and analyze network traffic at subscriber and aggregate level for capacity planning
Provide customer-intuitive tiered application services and guarantee application service level
agreements (SLAs)
Implement different service levels for different types of customers, content, or applications
Identify network abusers who are violating the acceptable use policy (AUP)
Enforce the AUP
Identify and manage peer-to-peer traffic, NNTP (news) traffic, and spam abusers Integrate Service Control solutions easily with existing network elements and business support
systems (BSS) and operational support systems (OSS)
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
17/136
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
18/136
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
19/136
1-5
Cisco Collection Manager User Guide
OL-26830-02
Chapter 1 Cisco Service Control and Cisco Service Control Engine Overview
SCE Platform Description
Figure 1-1illustrates a common deployment of an SCE platform in a network.
Figure 1-1 SCE Platform in a Network
LINKRX
Cisco SCE2000Series4xGBE
T X
RX MM T X
LINKRXT X
RX MM T X
LINK RXT X
RX MM T X
LINK RXT X
RX MM T X
GBE-1SUB LINE
NET
PWRB ST ATUS
PWRA
BYPASS
10/100 /1000
LINK/ACTIVE 10/100/1000
L INK/ACTIVE
GBE-2SUBLINE/CASCADENET
AUX
CONSOLE
MNG2
MNG1
UsersCorporate
Aggregation
deviceDSL
CMTS
SCE platform
Providernetwork Peer network
& Internet
92764
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
20/136
1-6
Cisco Collection Manager User Guide
OL-26830-02
Chapter 1 Cisco Service Control and Cisco Service Control Engine Overview
Management and Collection
Management and CollectionThe Cisco Service Control solution has a management infrastructure, which includes the following
components to manage all aspects of the solution:
Network management
Subscriber management
Service Control management
These management interfaces comply with common management standards and integrate with existing
OSS infrastructure (Figure 1-2).
Figure 1-2 Cisco Service Control Management Infrastructure
Network Management
The Cisco Service Control solution provides complete network Fault, Configuration, Accounting,
Performance, Security (FCAPS) Management.
Two interfaces provide network management:
Command-line interface (CLI)Accessible through the Console port or through a Telnet
connection, use the CLI for configuration and security functions.
SNMPProvides fault management (through SNMP traps) and performance-monitoringfunctionalities.
LINKRX
CiscoSCE2000Series4xGBE
T X
RX MM T X
LINKRXT X
RX MM T X
LINKRXT X
RX MM T X
LINKRXT X
RX MM T X
GBE-1SUB LINE NET
PWRB ST ATUS
PWR A
BYPASS
10 /100 /1000
L INK/ACTIVE 10 /100/1000
LINK/ACTIVE
GBE-2SUB L INE/ CASCADENET
AUX
CONSOLE
MNG2
MNG1
92763
Aggregationdevice SCE platform
RDRs
CLI and SNMPXML/RPC
Subscriber info
Router
DHCPor RADIUS
SubscriberManager
Provisioningsystem
Servicepolicy and quota
managementNetworkmanagement
CollectionManager
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
21/136
1-7
Cisco Collection Manager User Guide
OL-26830-02
Chapter 1 Cisco Service Control and Cisco Service Control Engine Overview
Subscriber Management
Subscriber Management
The Cisco Service Control Application for Broadband (SCA BB) enforces policies on different
subscribers and tracks usage on an individual subscriber basis. The Cisco Service Control management
suite (SCMS) Subscriber Manager is middleware used to bridge between the OSS and the SCE
platforms. Subscriber information is stored in the Subscriber Manager database. You can distributesubscriber information between multiple platforms according to the actual subscriber placement.
The Subscriber Manager provides subscriber awareness by mapping network IDs to subscriber IDs. It
can obtain subscriber information by using dedicated integration modules that integrate with
Authentication, Authorization, and Accounting (AAA) devices, such as RADIUS servers or DHCP
servers.
You can obtain subscriber information in the following ways:
Push ModeThe Subscriber Manager pushes subscriber information to the SCE platform
automatically when a subscriber logs in.
Pull ModeThe Subscriber Manager sends subscriber information to the SCE platform in response
to a query from the SCE platform.
Service Configuration Management
Service configuration management enables you to configure the general service definitions of a service
control application. You create a service configuration file and apply it to an SCE platform. The
configuration file contains settings for traffic classification, accounting and reporting, and control.
The SCA BB application provides tools that enable you to automate the distribution of these
configuration files to SCE platforms. This standards-based approach enables you to manage multiple
devices in a large network.
Service Control provides a GUI for creating and editing configuration files. Service Control also
provides a set of APIs for automating the creation of configuration files.
Data Collection
Data collection occurs in the Collection Manager from:
1. All analysis and data processing functions of the SCE platform result in the generation of Raw Data
Records (RDRs), which the SCE platform forwards using a simple TCP-based protocol and a RDR
protocol.
2. The Collection Manager processes the RDRs.
3. The Collection Manager software is an implementation of a collection system that receives RDRs
from one or more SCE platforms. It collects these records and processes them in one of its adapters.
Each adapter performs a specific action on the RDR.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
22/136
1-8
Cisco Collection Manager User Guide
OL-26830-02
Chapter 1 Cisco Service Control and Cisco Service Control Engine Overview
Data Collection
RDRs contain various information and statistics, depending on the configuration of the system. Three
main categories of RDRs include:
Transaction RDRsRecords generated for each transaction. A transaction is a single event detected
in network traffic. The identification of a transaction depends on the particular application and
protocol.
Subscriber Usage RDRsRecords generated per subscriber, which describe the traffic generated bythat subscriber for a defined interval.
Link RDRsRecords generated per link, which describe the traffic carried on the link for a defined
interval.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
23/136
C H A P T E R
2-1
Cisco Collection Manager User Guide
OL-26830-02
2Collection Manager Overview
This chapter is an overview of the Cisco Collection Manager operating with the Cisco Service Control
Engine (SCE). Collection Manager uses the hardware capabilities of the SCE platform and identifies the
combination of Cisco-specific applications that create the Cisco Service Control solution.
This chapter describes the following:
How Collection Manager works
The Raw Data Records (RDRs) that the SCE platforms generate and send to Collection Manager
The components of Collection Manager software package
The database used to store the RDRs
The chapter includes the following sections:
Data Collection Process, page 2-2
Raw Data Records, page 2-2
Collection Manager Software Package, page 2-5
Adapter, page 2-6
Using Databases, page 2-13
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
24/136
2-2
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Data Collection Process
Data Collection ProcessThe Cisco SCE platform generates RDRs. An application running on the SCE platform, such as the Cisco
Service Control Application for Broadband (SCA BB), specifies and defines the RDRs. The following
is the data collection process:
1. The SCE platform streams RDRs by using the simple, reliable RDR-Protocol. Integrating thecollection of data records with the Service Control Solution involves implementing RDR-Protocol
support in the collection system.
2. Collection Manager receives the RDRs from the SCE platform. The software modules recognize and
sort the various types of RDRs. The sorting uses preset categories, including type and priority.
Collection Manager queues the RDRs in persistent buffers.
3. Collection Manager adapters process each RDR. Each adapter performs a specific function on an
RDR:
Stores it in a customer adapter formatted file on a local machine
Sends it to an RDBMS application
Performs custom operationsYou can use preinstalled utility scripts to customize many of the parameters that influence the behavior
of Collection Manager.
Raw Data RecordsThe SCE platform generates RDRs. The RDRs, their fields, and their semantics depend on the specific
service control protocol (SCP) application. Each RDR type has a unique ID known as an RDR tag.
Table 2-1presents examples of SCP application RDRs:
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
25/136
2-3
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Raw Data Records
Table 2-1 Examples of SCP application RDRs
Report Type Description RDRs contain...
Periodic Subscriber usage report SCE platforms are subscriber-aware
network devices; they can report usage
records per subscriber.
Subscriber identifiers (such as the OSS
subscriber ID)
Traffic types (such as HTTP, streaming,
or peer-to-peer traffic)
Usage counters (such as total upstream
and downstream volume).
Note The Periodic Subscriber usage
report is necessary for usage-based
billing services and for network
analysis and capacity planning.
Note The SCA BB Subscriber Usage
RDRs fall under this category.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
26/136
2-4
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Raw Data Records
Transaction-level report SCE platforms perform stateful tracking of
each network transaction conducted on the
links on which they are located. Using thisstatefulness, the SCP tracks several OSI
Layer 7 protocols (such as HTTP, RTSP, SIP,
or Gnutella) to report on various
application-level attributes.
Basic Layer 3-4 attributes (such as
source IP, destination IP, and port
number) Protocol-dependant Layer 7 attributes
(such as user-agent, hostname for
HTTP, or email address of an SMTP
mail sender)
Generic parameters (such as time of day
and transaction duration).
Note These RDRs are important for
content-based billing schemes and
detailed usage statistics.
Note SCA BB application Transaction
RDRs fall under this category.
SCP application activity reports The SCP application can program the SCE
platform to perform various actions on
network traffic. These actions include
blocking transactions, shaping traffic to
certain rates and limits, and performing
application-level redirections. When such
an operation is performed, the SCP
application can produce an RDR.
SCA BB applications Breaching RDRs
Breaching RDRs are generated when
the system changes its active
enforcement on a subscriber (because
usage exceeded a set quota).
SCA BB applications Blocking RDRs
Blocking RDRs are generated when an
SCE platform blocks a network
transaction (according to the rules
contained in the current service
configuration).
Table 2-1 Examples of SCP application RDRs (continued)
Report Type Description RDRs contain...
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
27/136
2-5
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Collection Manager Software Package
Collection Manager Software PackageCollection Manager software package contains a group of processing and sorting modules. These
modules include the following components:
Raw Data Record Server, page 2-5
Categorizer, page 2-5
Priority Queue and Persistent Buffer, page 2-5
Raw Data Record Server
An SCE platform sends RDRs to the Collection Manager. The RDR server adds an arrival timestamp and
the ID of the source SCE platform. The RDR server then sends the RDR to the categorizer.
Categorizer
A categorizer classifies each RDR according to its RDR tag. It determines the destination adapter for the
RDR and the priority queue through which the RDR is sent.
An RDR can be mapped to more than one adapter. A qualified technician defines the flow in a
configuration file, based on user requirements.
Priority Queue and Persistent Buffer
Each adapter has one or more priority queues; a persistent buffer is assigned to each priority queue.
A priority queue queues each RDR according to the RDRs priority level and stores it in a persistent
buffer until the adapter processes it.
A persistent buffer is a nonvolatile storage area that ensures that the system processes RDRs even in
cases of hardware, software, or power failures.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
28/136
2-6
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Adapter
AdapterAdapters are software modules that transform RDRs to match the requirements of the target system. An
adapter distributes the RDRs upon requests from a database. Currently, the following adapters are
shipped with the Collection Manager:
JDBC Adapter, page 2-6
Comma-Separated Value Adapter, page 2-6
Custom Adapter, page 2-6
Topper Aggregator (TA) Adapter, page 2-7
Real-Time Aggregating Adapter, page 2-10
Some of the adapters send data to the database or write data to CSV files. The structures of the database
tables, and the location and structures of these CSV files are described in the Cisco Service Control
Application for Broadband Reference Guide.
Each adapter has its own configuration file. All the configuration files are similar in structure. For a
sample Real-Time Aggregating Adapter (RAG) configuration file, see the ragadapter.conf File section
on page A-5.
JDBC Adapter
The Java Database Connectivity (JDBC) adapter receives RDRs, processes them, and stores the records
in a database.
The JDBC adapter is compatible with any JDBC-compliant database server, You can configure the JDBC
adapter to use a database operating on a remote machine.
The JDBC adapter is preconfigured to support the following databases:
Sybase Adaptive Server Enterprise (ASE) 12.5 and 15.0
Oracle 9.2, 10.2, and 11
Disable the recycle binfeature available in Oracle 10 and later versions. You can set the initial value of
the recyclebinparameter in the text initialization file init.ora, for example,
recyclebin=off.
MySQL 4.1, 5.0, and 5.1
Comma-Separated Value Adapter
The comma-separated-value (CSV) adapter receives RDRs, processes them, and writes the records to the
files on the disk in the CSV format. Enhanced accounting and network traffic analysis records are
generated from the records. The service provider OSS can retrieves these records using standardmechanisms. A third-party billing system can also retrieve these records using standard mechanisms.
FTP is an example of a standard retrieval method.
Custom Adapter
The Custom Adapter allows you to configure the RDR format. The Custom Adapter receives records
with specified fields from an RDR.
http://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/scabbrg/scabbrg.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/scabbrg/scabbrg.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/scabbrg/scabbrg.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/scabbrg/scabbrg.html8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
29/136
2-7
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Topper Aggregator (TA) Adapter
You can configure only a few fields of TUR. Some of the configurable fields are Sub-ID, Upstream +
Downstream, and Application. The corresponding RDR is processed with those specific fields and stored
in a CSV file. The Custom Adapter also supports basic arithmetic operations (add, sub, maul) on a few
of the RDR fields.
The Custom Adapter process is disabled by default. Edit the ~scmscm/cm/config/cm.conf file in the
Collection Manager and restart Collection Manager to enable the Custom Adapter.For more information on enabling Custom Adaptor, see the Enabling an Adapter section on page 4-5
Topper Aggregator (TA) Adapter
The TA Adapter receives subscriber usage RDRs and aggregates the data. The TA Adapter outputs Top
Reports to the database in CSV format. Top Reports are lists of top subscribers for different metrics. The
top 500 volume or session consumers in the last hour is an example of a Top Report metric. The TA
adapter also sends the aggregated daily statistics of all the subscribers to the database.
The TA Adapter maintains a persistent saved state (saved to disk) to minimize data loss in case of failure
The TA Adapter uses the JDBC adapter infrastructure. The TA Adapter operates with either local or
remote JDBC-compliant databases.
TA Adapter supports IP-based aggregation along with the existing service-based or package-based
aggregation.The service and IP type-based aggregation is enabled by default. The TA Adapter aggregates
the records and lists the top subscribers for each combination of service and IP type with a different
metric.
The package-based aggregation is disabled by default. Update the agg_pkg_level property as true in the
~scmscm/cm/config/taadapter.conf file and restart Collection Manager to enable the package-based
aggregation.
Note The TA Adapter information is aggregated locally on a Collection Manager server. We do not reccomend
using the Collection Managers with a single database. This may affect the accuracy of TA Adapter
information.
Note A TA Adapter file is in the CSV format and populated with the RDR type SUR.
The TA Adapter has the following specifications:
TA Adapter Cycles, page 2-7
TA Adapter Memory Requirements, page 2-8
TA Adapter Cycles
The TA Adapter works in three cycles: short, long, and peak hours (specific hour range). Cycles are fixed
intervals. This data is temporarily stored in a persistent buffer directory with a default location of
~scmscm/cm/adapters/TAAdapter. At the end of an interval, the adapter outputs its aggregated
information to the database and to a CSV file. The default interval for the short cycle is 1 hour. The
default interval for the long cycle is 24 hours (every day at midnight). You can configure an interval
(defined in minutes) and its start and end time. Configure the interval for the peak hours cycle. At the
end of the peak hours, the adapter aggregates and outputs details of the top subscribers to the database.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
30/136
2-8
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Topper Aggregator (TA) Adapter
Note The long-cycle interval must be a multiple of the short-cycle interval.
The activities in each cycle differ slightly, as follows:
Short cycleAt the end of each short cycle, the adapter:
Adds the aggregated Top Reports of the cycle to the short cycle database table
Saves the current state file in case of power failure
Long cycleAt the end of each long cycle, the adapter:
Adds the aggregated Top Reports of the cycle to the long cycle database table
Saves the current state file in case of power failure
Creates a CSV file to contain the aggregated statistics for the long-cycle period
Peak-hour cycleAt the end of each peak-hour cycle, the adapter:
Adds the aggregated Top Reports of the cycle to the peak hour cycle database table
Saves the current state file in case of power failure
Note The long cycle data is saved every hour. The save file has 0 to 23:00 hours of data if a power shutdown
occurs between 23:00 hrs and 24:00 hrs. The CSV file contains aggregated data. The current state is
saved in a nonreadable format.
TA Adapter Memory Requirements
The TA Adapter requires sufficient dedicated memory. Configure the value of the memory in the cm.conf
file in the following location:
[adapter_mem]
com.cisco.scmscm.adapters.topper.TAAdapter=To calculate the recommended amount of memory for the TA Adapter, use the following formula:
Memory (MB) = 3 * TOTAL_SUBSCRIBERS * ((AVG_SUBS_ID_LENGTH + (2 *
NUM_OF_PERIODS * NUM_OF_SERVICES * NUM_OF_IPTYPES ) + (32 *
NUM_OF_SERVICES) ) /(1024 * 1024)) * (NUM_OF_IPTYPES )
To calculate the recommended amount of memory for the TA Adapter with Package Enabled
Aggregation, use the following formula:
Memory (MB) = 3 * TOTAL_SUBSCRIBERS * ((AVG_SUBS_ID_LENGTH + ((((20 *
NUM_OF_PKGS) +48) + (2 * NUM_OF_PERIODS * NUM_OF_SERVICES *
NUM_OF_IPTYPES))+ (32 * NUM_OF_SERVICES) ) /(1024 * 1024)) * (NUM_OF_PKGS ) *
(NUM_OF_IPTYPES )
The definitions of the fields in the formula are:
TOTAL_SUBSCRIBERS is the total number of subscribers.
AVG_SUBS_ID_LENGTH is the average character length of a subscriber.
NUM_OF_PERIODS = Total number of Aggregation cycles. Default value is 2.
NUM_OF_IPTYPES = Total no of ip types supported +1
NUM_OF_SERVICES = Total number of active services + 1
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
31/136
2-9
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Topper Aggregator (TA) Adapter
NUM_OF_PKGS = Maximum number of packages for a particular subscriber +1
Note For Linux JRE 32 bit, the configured memory maximum is 2 GB.
For Linux JRE 64 bit, you can set higher values for the configured memory.
Note For Solaris JRE 32 bit, the configured maximum memory is 3.5 GB.
For Solaris JRE 64 bit, you can set higher values for the configured memory. To configure the TA or
RAG adapters to run with the JRE 64 bit, see the [adapter_mem] Section section on page B-3.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
32/136
2-10
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Real-Time Aggregating Adapter
Real-Time Aggregating Adapter
The RAG adapter processes RDRs of one or more types and aggregates the data from predesignated field
positions into buckets. The contents of the buckets are written to CSV files. The RAG adapter has the
following components and processes:
RAG Adapter Aggregation Buckets, page 2-10
Flushing a Bucket, page 2-10
RAG Adapter Process for HTTP Transaction Usage RDR, page 2-11
RAG Adapter Process for Video Transaction Usage RDR, page 2-11
RAG Adapter Process for Subscriber Usage RDR, page 2-11
Managing OSFP support for Subscriber Usage RDR, page 2-12
RAG Adapter Aggregation Buckets
A RAG adapter aggregation bucket is indexed by combining values from fields in the RDR. The indexing
relation can be one-to-one or many-to-one.
The values in the bucket-identifying fields are processed using closures (equivalence classes), which are
configured per type of RDR.
Bucket-identifying field = field number 3
Closures: 4 = 4,5,6; 10 = 8,10,11 Value in field 3 = 4, 5, or 6; field reported as 4
Value in field 3 = 8, 10, or 11; field reported as 10
You can configure the RAG adapter to monitor the values in certain fields for change relative to the
values in the first RDR that entered the bucket. For each monitored field, an action is performed when a
value change is detected. The supported actions are:
Checkpoint the bucket without aggregating this RDR into it, and start a new bucket with this RDR.
Issue a warning to the user log.
Buckets, closures, triggers, and trigger actions are defined in an XML file. For a sample XML file, see
the ragadapter.xml File section on page A-6.
Flushing a Bucket
When a bucket is flushed, it is written as one line to a CSV file.
The trigger for flushing a bucket (a checkpoint) is the earliest occurrence of any of the following:
Time elapsed since the creation of a bucket reaches a configured duration
Volume in an accumulated field in a bucket exceeds a configured amount
A RAG Adapter, or the entire Collection Manager, goes down
An RDR arrives at the bucket with some new value (relative to the bucket contents) in some field
The trigger to close a CSV file is the earliest occurrence of one of the following:
Time elapsed since the creation of a file has reached a set duration
Number of lines in a file has reached a set number
A RAG Adapter, or the entire Collection Manager, goes down
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
33/136
2-11
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Real-Time Aggregating Adapter
RAG Adapter Process for HTTP Transaction Usage RDR
If a corresponding RDR TAG is configured under the RAG adapter section in the queue.conffile before
Collection Manager is started, the RAG adapter processes the HTTP_TUR RDRs.
An XML file specific to HTTP_TUR is included in Collection Manager distribution for the RAG adapter
in order to manage the HTTP_TUR RDR fields. The aggregation period for processing the RDRs isspecified in the http_TURs.xml file.
Aggregation is based on the domain, package, and service for the corresponding HTTP Transaction
Usage RDR. At the end of the aggregation period, the adapter adds the aggregated Top Reports for hosts
to the RPT_TOP_HTTP_HOSTS database table. The adapter adds the aggregated Top Reports for
domains to the RPT_TOP_HTTP_DOMAINS database table.
RAG Adapter Process for Video Transaction Usage RDR
If you configure a corresponding RDR TAG under the RAG adapter section in queue.conffile before
you start Collection Manager, the RAG adapter processes VIDEO_TUR RDRs.
Collection Manager distribution includes an XML file specifically for VIDEP_TUR, which enables the
RAG adapter to manage VIDEO_TUR RDR fields. The aggregation period for processing the RDRs is
specified in the video_TURs.xml file.
Aggregation is based on the domain, package, and service for the corresponding VIDEO Transaction
Usage RDR. At the end of the aggregation period, the adapter adds the aggregated Top Reports for hosts
to the RPT_TOP_VIDEO_HOSTS database table. Also, the adapter adds the aggregated Top Reports for
domains to the RPT_TOP_VIDEO_DOMAINS database tables.
RAG Adapter Mobile Based Reports
Collection Manager supports both GSM and CDMA mobile-based reports. GSM reports are enabled by
default.
The ~scmscm/cm/config/ragadapter.conf
file property (vsa_type=gsm or cdma) configures the mobile report type processed.
A user should to place the related XML files in ~scmscm/cm/config/ragadapter for the Collection
Manager. By default all the XML files are available in the ~scmscm/cm/config/ragadapter/repository
directory.
RAG Adapter Process for Subscriber Usage RDR
If a corresponding RDR TAG is configured under the RAG adapter section in the queue.conf file before
Collection Manager is started, the RAG adapter processes the NUR RDRs. The Subscriber Usage RDRs
are processed in two ways:
Aggregation Based on VSA Fields, page 2-11
Aggregation Based on Package, page 2-12
Aggregation Based on VSA Fields
VSA field aggregation supports either GSM or CDMA mobile-based reports:
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
34/136
2-12
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Real-Time Aggregating Adapter
Collection Manager supports one of the mobile-based reports (either GSM or CDMA). By default, GSM
reports are enabled. In the ~scmscm/cm/config/ragadapter.conf file, a new property (VSA_Type = gsm
or cdma) is added to configure which mobile report Collection Manager needs to process.
During restart, based on the vsa_type configuration, the Collection Manager will copy the corresponding
xml config file to the ~scmscm/cm/config/ragadapter file for processing.
Aggregation Based on GSM-Specific VSA Fields
The vsa_SURs.xml file manages GSM-specific VSA fields in the Subscriber Usage RDRs. The
aggregation period for processing the RDRs is specified in this file. Aggregation is based on the
GSM-specific VSA fields (APN, SGSN, NETWORK_TYPE, DEVICE_TYPE, and
USER_LOCATION). At the end of the aggregation period, the adapter adds the aggregated Top Reports
related to the GSM-specific VSA fields to their corresponding database tables:
RPT_TOP_APN
RPT_TOP_SGSN
RPT_TOP_NETWORK_TYPE
RPT_TOP_DEVICE_TYPE RPT_TOP_USER_LOCATION
Aggregation Based on CDMA-Specific VSA Fields
The cdma_SURs.xml file manages the CDMA-specific VSA fields in the Subscriber Usage RDRs. The
aggregation period for processing the RDRs is specified in this file. Aggregation is based on the
CDMA-specific VSA fields (PCF, HOME AGENT, MEID). At the end of the aggregation period, the
adapter adds the aggregated Top Reports related to the CDMA-specific VSA fields to their
corresponding database tables:
RPT_TOP_PCF
RPT_TOP_HOME_ AGENT
RPT_TOP_MEID
Aggregation Based on Package
The vlink_BW_per_pkg.xml file manages upstream and downstream VLINKs in the Subscriber Usage
RDRs. The aggregation period for processing the RDRs is specified in this file.
Aggregation is based on the up and down VLINK fields. At the end of the aggregation period, the adapter
adds the aggregated Top Reports for the up VLINKS to the RPT_UVLINK database table. Also, the
adapter adds the aggregated Top Reports for the down VLINKs to the RPT_DVLINK database table.
Rag Adapter package aggregation happens based on PACKAGE_ID,
UP_VLINK_ID/DOWN_VLINK_ID, and IP_TYPE.
Managing OSFP support for Subscriber Usage RDR
Operating System Finger Printing (OSFP) is supported in Collection Manager software.
The ~scmscm/script/updateVSAindex.sh script supports backwards compatibilty.
The following two properties are added in the ~scmscm/cm/config/ragadpater.conf file:
attr_index - index position of attribute indicator field in NUR RDR in current the Cisco SCOS
version
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
35/136
2-13
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Using Databases
attr_shift_pos - Number of fields to be shifted
Check the VSA Attribute Indicator field index value for the current Cisco SCOS version. This is based
on the Cisco SCOS version update attr_index , attr_shift_pos properties in
~scmscm/cm/config/ragadpater.conf file. The RAG Adapter section on page B-15details the RAG
adapter configuration file ragadapter.conf. Then execute the script ~scmscm/script/updateVSAindex.sh
script. The script updates the corresponding XML file (vsa_SURs.xml/cdma_SURs.xml).Table 2-1shows the VSA Attribute Indicator field index values.
Using DatabasesCollection Manager can use either a bundled database or an external database to store the RDRs supplied
by the SCE platforms. The following sections describe the procedures:
Using the Bundled Database, page 2-13
Using an External Database, page 2-14
Using the Bundled Database
In the bundled mode, Collection Manager uses the Sybase Adaptive Server Enterprise database. Thisdatabase enables you to do the following:
Support transaction-intensive enterprise applications
Store and retrieve information online
Warehouse needed information by putting it in a central depository
The Sybase database is located on the same server as the other Collection Manager components. It uses
a simple schema that includes a group of small, simple tables.
1. The JDBC adapter sends the converted RDRs to the database, where the RDRs are stored in the
tables of the simple schema.
2. You can access these records by using standard database query and reporting tools. (Cisco provides
a template-based reporting tool that can generate reports on subscriber usage, network resourceanalysis, and traffic analysis. For information about the Service Control reporting tool, see the Cisco
Service Control Application Reporter User Guide.)
You can maintain the database by using operating system commands and scripts. Collection Manager
supports automatic purging of old records from the bundled database. By default, Collection Manager
automatically purges the report table of every record that is older than two weeks and polls the records
once every hour. You can configure database maintenance by using the dbperiodic.sh utility script. For
more information on database maintenance, see the Managing the Periodic Deletion of Old Records
section on page 5-3.
Table 2-2 VSA Attribute Indicator Field Index Values
SCOS Version attr_index attr_shift_pos
3.8.5 17 0
3.8.0 17 0
3.7.5 17 0
3.7.0 14 3
http://-/?-http://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/reporterug/reporter.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/reporterug/reporter.htmlhttp://-/?-http://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/reporterug/reporter.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/reporterug/reporter.html8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
36/136
2-14
Cisco Collection Manager User Guide
OL-26830-02
Chapter 2 Collection Manager Overview
Using an External Database
Using an External Database
With the JDBC adapter, you can use any JDBC-compliant database (for example, Oracle or MySQL).
The database can be either local or remote. To use an external database, perform the following tasks:
Step 1 Configure the JDBC adapter to use this database.
Step 2 Configure a database pack to supply Collection Manager with the parameters of the database (such as
its IP address and port).
Step 3 Supply a JDBC driver for the database so that the adapter can connect to the database.
For details about configuring Collection Manager to work with an external database, see Chapter 5,
Managing Databases and the Comma-Separated Value Repository.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
37/136
C H A P T E R
3-1
Cisco Collection Manager User Guide
OL-26830-02
3Installing Collection Manager
This chapter describes how to install Collection Manager and the connected database. The chapter also
explains how to run Collection Manager.
Note For a typical installation and configuration, see the Collection Manager Quick Start Guide.
This chapter includes the following sections:
System Requirements, page 3-2
How to Install Collection Manager, page 3-8
Configuring the External MySQL Server, page 3-16
Uninstalling the Sybase Database and Collection Manager Software, page 3-17
Upgrading Collection Manager to Version 3.8.x, page 3-18
http://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/cm_qsg/cm_qsg.htmlhttp://www.cisco.com/en/US/docs/cable/serv_exch/serv_control/broadband_app/rel38x/cm_qsg/cm_qsg.html8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
38/136
3-2
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
System Requirements
System RequirementsThe Collection Manager has the following system requirements:
Supported Platforms, page 3-2
Checking System Prerequisites, page 3-2 Hardware Requirements, page 3-3
Solaris Requirements, page 3-3
Red Hat Linux Requirements, page 3-5
CentOS Linux Requirements, page 3-7
Distribution Content, page 3-7
Default Configuration Settings, page 3-7
Supported Platforms
You can install Collection Manager on any of the following platforms:
Sun SPARC machine (64- bit) running 64-bit versions of Solaris 9 or Solaris 10. (See the Solaris
Requirements section on page 3-3.)
Intel machine (32 bit or 64-bit) running 32-bit versions of Red Hat Enterprise Linux 4.x, Red Hat
Enterprise Linux 5.x, or 64-bit versions of Red Hat Enterprise Linux 5.x. (See the Red Hat Linux
Requirements section on page 3-5.)
Intel machine (32 bit or 64-bit) running 32-bit or 64-bit versions of CentOS 5.x. (See the CentOS
Linux Requirements section on page 3-7.)
Intel machine (32 bit or 64-bit) running VMware Server or VMware ESX
VMware-VMvisor-Installer-4.0.0-164009.x86_64.iso.
Any Cisco Unified Computing System
All the configurations use a 32-bit Java Virtual Machine (JVM).
Caution Collection Manager must run on a dedicated server. The local database for Collection Manager is also
located on that server. You cannot run the Cisco Subscriber Manager or other software applications on
the same server that contains the database.
Note When using the bundled Sybase database, the server on which you install Collection Manager can have
a maximum of 4 CPU cores.
Checking System Prerequisites
The Collection Manager distribution contains a script, check_prerequisites.sh, located in the
install_scriptsdirectory. The script helps to determine if a system meets the requirements for installing
a Collection Manager and the bundled Sybase database.
check_prerequisites.sh [ --sybhome=SYBHOME ] [ --cmhome=CMHOME ] [ --datadir=DATADIR ]
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
39/136
3-3
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Hardware Requirements
Table 3-1provides a list of the check_prerequisites.sh script options.
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
Free space for the Collection Manager and the Sybase database
Names for all network interface cards (NICs)
Sybase kernel parameters
Locale and time zone formats
Hardware Requirements
The minimum hardware requirements for Collection Manager are:
500-MHz CPU
One GB RAM per CPU
Hard disk:
One hard disk (18 GB minimum)
For bundled installations, a second hard disk of at least 30 GB is recommended to store Sybase
data.
100BASE-T network interface
Note The minimum hardware requirements apply only to small deployments. Medium or large deployments
have higher hardware requirements. Your network design expert is the best source of information on the
required hardware for a particular deployment.
Solaris Requirements
Install Collection Manager Release 3.1.0 or later on Sun SPARC Machines:
Software and Environment, page 3-4
Setting the Locale and Time Zone, page 3-5
Table 3-1 check_prerequisites.sh Script Options
--sybhome=SYBHOME Intended home directory for Sybase installation
--datadir=DATADIR Intended data directory for Sybase data files (for
the Datadir installation method)
--cmhome=CMHOME Intended home directory for Collection Manager
installation
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
40/136
3-4
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Solaris Requirements
Software and Environment
Collection Manager requires the following software version when running on Solaris:
Solaris Version 5.9 64-bit build 04/01 or later (currently, only Solaris Version 5.9 and 5.10 are
supported).
Solaris 9Patch level 9 is recommended
Solaris 10Patch level 10 is recommended
Solaris Core Installation.
Install the additional packages, as shown in Table 3-2.
If you are installing Collection Manager in bundled mode with the Sybase database, install the
package shown in Table 3-3.
(Optional) You can install the packages listed in Table 3-4(for sysadmin applications such as
sys-unconfig).
You can download these packages from http://www.sunfreeware.com/
The root (/) partition must have at least 104 MB of free space to install these packages.
At least 8 GB free on the partition for Collection Manager. (This memory is used for CSV storage
and persistent buffers.)
At least 3 GB free on one partition for the Sybase home directory (for installations with bundled
Sybase).
For bundled installations, a second hard disk of at least 30 GB is recommended to store Sybase data.
Table 3-2 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
Table 3-3 SUNWipc Package
system SUNWipc Interprocess Communication
Table 3-4 Optional Packages
system SUNWadmap System administration
applications
system SUNWadmc System administration core
libraries
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
41/136
3-5
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Red Hat Linux Requirements
Free space on one partition to hold the desired size of the Sybase data and logs (for installations with
bundled Sybase). You can configure memory size during installation.
The FTP server requires listening to port 21 so that the SCA Reporter can authenticate the server.
All the IP addresses configured for the machine NICs require hostnames associated with them in the
/etc/hosts or in another active naming service. The requirement is for installations with the bundled
Sybase database. Verification is required for an installation due to a limitation of the SybaseAdaptive Server Enterprise.
Use the set_shmmax.shscript to configure the kernel memory for installations with the bundled
Sybase. The script is located under install-scripts/.
At startup ,you must load the IPC module by inserting the following lines in the file /etc/system:
forceload: sys/shmsys
If you are using database periodic delete, enable the scmscm user to schedule and run cron jobs.
Setting the Locale and Time Zone
For correct Collection Manager and Sybase operation, use the locale U.S. English.Add the following line in the/etc/TIMEZONEconfiguration file to set the locale:
LANG=en_US
Note Restart Collection Manager to change to this configuration.
To use the U.S. English locale, Collection Manager must be running on the Solaris operating system.
Verify that the locale is installed by ensuring 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 can lead
to problems. Set the time zone in the /etc/TIMEZONE configuration file by country (supported)name, as in the following example.
TZ=Japan
Verify that the country name is supported as a time zone setting by ensuring that it is listed in the
directory/usr/share/lib/zoneinfo.
If you must use GMT offset, use the zoneinfo format by prepending the prefix :Etc/, as in the
following example:
TZ=:Etc/GMT+5
Red Hat Linux Requirements
The following information applies to running the Collection Manager using Red Hat Linux.
Software and Environment, page 3-6
Setting the Locale and Time Zone, page 3-7
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
42/136
3-6
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Red Hat Linux Requirements
Software and Environment
Collection Manager Version 3.7.5 or later requires the following software when running on Red Hat
Linux:
Red Hat Linux 4.x:
kernel-2.6.9-5
glibc-2.3.4-2
compat-libstdc++-33-3.2.3-47.3
Minimum patch level requiredUpdate 7
Red Hat Linux 5.x:
kernel-2.6.18-8.el5
glibc-2.5-12
compat-libstdc++-33-3.2-61
Minimum patch level requiredUpdate 5.3
Red Hat Enterprise Linux 6.x
Installing Red Hat Linux
For Red Hat Linux installations, perform the following steps:
Apply the latest recommended patches from Red Hat.
Reserve at least 8 GB on the partition where you want to install Collection Manager.
Collection Manager uses this disk space for CSV storage and persistent buffers.
If you are using database periodic delete, enable the scmscm user to schedule and run cron jobs.
If you use Red Hat Enterprise Linux 6.x, confirm that the desired database is compatible with Red
Hat Enterprise Linux 6.x.
Note Red Hat Enterprise Linux 6.x does not support the Collection Manager bundled Sybase database.
Installing Red Hat Linux and the Sybase Database Bundled with the Collection Manager
Note Red Hat Enterprise Linux 6.x does not support the Sybase database bundled with the Collection
Manager.
For installations with the Sybase database bundled with the Collection Manager, perform the following
steps: Install the compat-libstdc++ package. This package is available on the Red Hat installation CD.
Install the current Sybase patches.
Reserve at least 1 GB on one of the partitions for the Sybase home directory.
Verify that all the configured IP addresses for the machine NICs have hostnames associated with
them in the/etc/hosts or in another active naming service. This action is required due to a limitation
of Sybase Adaptive Server Enterprise.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
43/136
3-7
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
CentOS Linux Requirements
Use the set_shmmax.sh script (located under the install-scripts/) to configure the kernel memory.
Setting the Locale and Time Zone
For correct Collection Manager and Sybase operation, use the locale U.S. English (en_US).
CentOS Linux Requirements
Install Collection Manager Version 3.6.5 or later on any i386 that runs CentOS Linux. Collection
Manager requires the following software version when running on CentOS:
CentOS Linux 5.x:
kernel-2.6.18-8.el5
glibc-2.5-12
compat-libstdc++-33-3.2.3-61
Note CentOS is supported only on Collection Manager software Release 3.6.5 and later.
Distribution Content
Collection Manager installation kit contains scripts for installing Collection Manager and the Sybase
database.
It also contains:
Scripts to support file gathering
Scripts for periodic Sybase maintenance
Default Configuration Settings
Configure the settings for Collection Manager during installation.
These settings include:
Adapters to enable and their locations
Priority Queue parameters
Target adapters for each type of RDR (by RDR tag value)
Various logging policies
Note Permit only qualified personnel to change these settings.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
44/136
3-8
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
How to Install Collection Manager
How to Install Collection ManagerThis section describes how to install Collection Manager Version 3.1.0 or later and the Sybase database:
Getting Collection Manager Software, page 3-8
Collection Manager Software Ports, page 3-9 Installing the Bundled Sybase Database, page 3-9
Installing the Collection Manager Software, page 3-12
Note You can install the Collection Manager on Solaris, Red Hat Linux, or CentOS Linux.
Getting Collection Manager Software
To download Collection Manager software:
Step 1 Goto to the Cisco Product/Technology Support Download Software page for the Cisco Service Control
Collection Manager at:
http://www.cisco.com/cisco/software/release.html?mdfid=279573187&flowid=7155&softwareid=2827
67641&release=3.7.5-P1&relind=AVAILABLE&rellifecycle=&reltype=latest
Note Optionally, you can go to the same Cisco Service Control Collection Manager software
download page from Cisco.com by navigating to Cisco Product/Technology Support >
Download Software > Service Exchange > Cisco Service Control > Cisco Service Control
Management Suite > Cisco Service Control Collection Manager.
Step 2 Enter your Cisco CCO password when prompted.
Step 3 Download the SCMS-CM Installation software package for your specific operating system. Specific
software packages may consist of a single download or consecutive multiple downloads. If there is a
single file package, go to Step 5.
Step 4 If there are consecutive multiple downloads, move the downloaded files to the target machine and join
them into a single .tar file.
For example:
# cat cm_part1 cm_part2 >/usr/tmp/cm_full_package.tar
Step 5 Extract the complete package into a temporary directory.
For example:
# mkdir /usr/tmp/cm_install_temp# cd /usr/tmp/cm_install_temp
# tar xvf ../cm_full_package.tar
http://www.cisco.com/cisco/software/release.html?mdfid=279573187&flowid=7155&softwareid=282767641&release=3.7.5-P1&relind=AVAILABLE&rellifecycle=&reltype=latesthttp://www.cisco.com/cisco/software/release.html?mdfid=279573187&flowid=7155&softwareid=282767641&release=3.7.5-P1&relind=AVAILABLE&rellifecycle=&reltype=latesthttp://www.cisco.com/cisco/software/release.html?mdfid=279573187&flowid=7155&softwareid=282767641&release=3.7.5-P1&relind=AVAILABLE&rellifecycle=&reltype=latest8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
45/136
3-9
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Collection Manager Software Ports
Collection Manager Software Ports
Table 3-5describes the TCP/UDP ports on which Collection Manager software and associated
components (such as the Sybase database) listen. This table helps a network administrator to understand
the behavior of the software and its adherence to security policies.
The device listens constantly on the ports in the table. If you cannot enable access on these port numbers,
certain operations can fail. Some operations (such as file transfer) cause a device to temporarily open
ports other than the listed ports. However, these ports close automatically when the operation that opens
additional ports ends.
Installing the Bundled Sybase Database
If you do not want to install Sybase (for example, when working in unbundled mode), see the Installing
the Collection Manager Software section on page 3-12.
Note The maximum size for the bundled Sybase database is 50 GB. Use an external database for databases
over 50 GB.
Note Installing the Sybase database can take as many as 3 hours.
Table 3-5 Ports on Which Collection Manager Listens Constantly
Port Number Description
33000 The SCE devices use this port to send RDRs for data collection.
33001 Internal collection manager.
Note Access is required only from the local machine; external access can
be blocked.
9092 HTTP technician interface.
4100 Sybase database connectivity through ODBC or JDBC. Required for access
to the database (for installations with bundled Sybase).
10991120 RMI. Used as the management interface between the data collector and theService Control management server.
22000 FTP server of Collection Manager.
Note FTP transactions can listen on other ports (22001 to 22100) for data
transfer. The protocol negotiates the port number.
7787 Internal logging of the management user log.
Note Access is required only from the local machine; external access can
be blocked.
14375 The Cisco SCA BB console uses this port to send symbol definitions
(values.ini) to Collection Manager.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
46/136
3-10
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Installing the Bundled Sybase Database
Note You can install Collection Manager with the bundled Sybase database on a server with a maximum of
four CPU cores. This is a limitation of the Sybase license.
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. Run the /install-scripts/uninstall.sh --sybase script.
Actions the installsyb.sh Script Performs
The installsyb.sh script installs the Sybase database. The script performs the following actions:
Verifies the shmem setting for Sybase in the /etc/system(for Solaris) or the /etc/sysctl.conf file (forRed Hat Linux). If the setting is not there, the script inserts it and reboots (after prompting you).
Adds a user Sybase and group Sybase.
Runs the Sybase installer for your platform. Builds a Sybase server that includes Sybase users and passwords.
Starts Sybase.
Runs SQL scripts to create Collection Manager database structure. This process is lengthy and
requires restarting Sybase several times.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
47/136
3-11
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Installing the Bundled Sybase Database
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 installsyb.sh script.
installsyb.sh --sybhome=SYBHOME {-datadir=DATADIR}{--y|--n}
SYBHOMEis the home directory of the Sybase user (have 4 GB free for Solaris and 3 GB free for
Linux)
Select one of the following data location options:
Specify --datadir=DATADIR, where DATADIR is a directory in which to s tore all Sybase data
Use a location in a partition in which at least 15 GB is free.
If you specify a DATADIR, all Sybase data is stored as normal files in that directory. The default
sizes are 10 GB for data, 3 GB for logs, and 2 GB for the temporary storage of Sybase. During the
installation process, ownership of the directory changes to the Sybase user.
A fresh install requires an empty "DATADIR" directory.
Note Using an external database, such as MySQL or Oracle, requires creating a schema and DB USER with
the required privileges. Reconfigure Collection Manager to the database using the
~scmscm/scripts/dbconf.sh script option.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
48/136
3-12
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Installing the Collection Manager Software
Installing the Collection Manager Software
This section describes how to install Collection Manager.
Information About the install-cm.sh Script
To install Collection Manager server, use the install-cm.sh script.
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 (can't be used with -d)
-h print this help and exit
Description of the options:
-d CMDIR 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 :
-o Use this option when you wish to upgrade the existing
installation while preserving the current configuration.
(can't be used with -d)
Actions install-cm.sh PerformsThe install-cm.sh script performs the following actions:
If needed, creates an scmscm user and a scmscm group.
Optionally, creates the home for this user
Populates the home of scmscm with Collection Manager files and scripts
Installs the extra component private JRE in the ~scmscm/cm/lib library.
Creates boot script symbolic links for the Sybase and scmscm users in /etc/init.d and /etc/rcX.d
Note All Collection Manager scripts run in the Bash shell environment. No other shells are supported.
Step 1 Change the directory to install-scripts under the distribution kit root.
Step 2 Run the install-cm.sh script.
After running the script, a user-driven configuration manager presents options for the basic configuration
of Collection Manager.
Step 3 Choose whether to enable or not enable the RAG adapter. For more information on the RAG adapter, see
the Real-Time Aggregating Adapter section on page 2-10.
Do you want to enable the RAG Adapter? (yes/no):
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
49/136
3-13
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Installing the Collection Manager Software
Step 4 You can choose to set up the Collection Manager database at the time of installation or configure it at a
later time.
Would you like to configure the database?: yes
Step 5 If you choose to configure Collection Manager database:
a. Select the number corresponding to the relational database management system of the connecting
database:
Enter the DB type:
1 - Oracle
2 - MySQL
3 - Sybase4 - exit
Enter your choice:
b. Enter the following server information or pressenterto leave at the default shown.
Enter DB server host (default localhost):Enter DB server listening port (default port no) :
Enter DB server instance id (default schema) :
Enter DB schema user name (default user_id) :Enter DB schema user password (default password):
Do you want to test the DB connection? (yes/no):
Please answer using "yes" or "no"
If you choseyes, the following text appears:
PASS:db is upDB connection succeeded.
NOTE: The user name created for SCMS-CM is scmscm. You may want to set a password forthis account now.
Step 6 Restart Collection Manager for the database configuration to take effect.
Step 7 To start Collection Manager, chooseyes:
Would you like to start CM now? (yes/no): yes
The most basic installation of Collection Manager software is done.
Step 8 (Optional) Set a password.
Run the following command to set the password for the scmscm user:
passwd scmscm
Note Be sure to record the password that you choose.
Step 9 (Optional) Increase the amount of memory allocated to the TA adapter.
An application that uses the TA adapter may require an increase in the amount of allocated memory. Theneed to increase memory depends on the number of subscribers Collection Manager manages. 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.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
50/136
3-14
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Installing the Collection Manager Software
d. Save and close the file.
Note For information about calculating the TA Adapter memory, see the TA Adapter Memory Requirements
section on page 2-8.
Step 10 (Optional) Increase the amount of memory allocated to the RAG adapter.
An application that uses the RAG adapter can require an increase in the amount of allocated memory.
The need to increase memory depends on the number of subscribers Collection Manager manages and
on the 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, configure a dbpackto connect Collection Manager to the database. See
Chapter 5, Managing Databases and the Comma-Separated Value Repositoryfor instructions.
Note The app_conf_dirvalues of the JDBC (jdbcadapter.conf) and TA (taadapter.conf) adapter configuration
files point to the most recent directory of the desired applications by default.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
51/136
3-15
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Installing the Collection Manager Software
Step 11 (Optional) Install and activate the periodic delete procedures for the database tables.
(For information about configuring the behavior of periodic delete, see the Managing the Periodic
Deletion of Old Records section on page 5-3.)
Note If reports are sent to the database, and you do not install and activate the periodic delete procedures, thesecond disk might overflow.
a. Install the periodic delete procedures.
Log in as the scmscm user, start Collection Manager. Wait 1 - 2 minutes for the creation of the
database tables. Run the script:
~scmscm/db_maint/create_periodic_del_procs.sh
b. Activate the automatic invocation of the periodic delete procedures by running the following
command:
~scmscm/scripts/dbperiodic.sh --load
Step 12 Start Collection Manager by running the ~scmscm/cm/bin/cm start.The script performs the following actions:
Starts all the adapters enabled in Collection Manager.
Updates the CONF_SE_TZ_OFFSET table with the timezone offset.
Populates the IMEI_DEVICETYPE table with default values. This occurs when the table is not
created and no records exist in the table.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
52/136
3-16
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Configuring the External MySQL Server
Configuring the External MySQL ServerYou can configure Collection Manager to operate with an external server operating the MySQL Server
4.1 software or the MySQL Server 5.0 software. To do this, log in to the MySQL Server and manually
create a schema and a user with necessary privileges before configuring Collection Manager.
Log in to the server using root privileges and execute the following MySQL commands to createpqb_admin with root privileges:
create database apricot;
create user 'pqb_admin' identified by 'pqb_admin';
grant all privileges on *.* to 'pqb_admin'@'localhost' identified by 'pqb_admin' withgrant option;
grant all privileges on *.* to 'pqb_admin'@'' identified by 'pqb_admin' withgrant option;
grant all privileges on *.* to 'pqb_admin'@'%' identified by 'pqb_admin' with grantoption;
This set of privileges will grant root privilege to the pqb_admin user. Redefine user privileges to restrict
user access.
8/10/2019 Cisco Collection Manager User Guide, Release 3.8.x_cmug.pdf
53/136
3-17
Cisco Collection Manager User Guide
OL-26830-02
Chapter 3 Installing Collection Manager
Uninstalling the Sybase Database and Collection Manager Software
Uninstalling the Sybase Database and Collection ManagerSoftware
The following sections describe how to uninstall the Sybase database and Collection Manager:
Uninstalling Sybase, page 3-17
Uninstalling Collection Manager Software, page 3-17
Uninstalling Sybase
To uninstall the Sybase database, perform the following steps:
Step 1 Log in to the Collection Manager as the root user.
Step 2 Uninstall Sybase.
Change the directory to install-scripts under the distribution kit root directory, and enter:
./uninstall.sh --sybase
Step 3 Edit the /etc/systemfile for Solaris or the /etc/sysctl.conffile for Red Hat Linuxand remove the Sybaseshmemsetting.
Uninstalling Collection Manager Software
To uninstall Collection Manager software, perform the following steps:
Step 1 Log in as the root user.
Step 2 Uninstall Collection Manager software.
Change the directory to install-scripts under the distribution kit root directory, and enter:
./uninstall.sh --cm
8/10/2019 Cisco Collection Manager User Guide