About this Guide
This document is a guide to the configuration and management of the Subscriber Manager (SM) application. It contains explanations of relevant concepts and terminology in addition to instructions on how to install, configure, and use the SM.
Note
The guide assumes a basic familiarity with the telecommunications equipment and installation procedures, concepts of the Service Control Management Suite, the Service Control Engine (SCE) 1000, SCE 2000, and SCE 8000 platforms, and their related components.
This Cisco Service Control Management Suite Subscriber Manager User Guide documents the application that processes subscriber records and maintains the subscriber database for use by the SCE platform. It contains instructions for installing the SM and the TimesTen database, editing and installing the configuration file, and managing the system using the Command-Line Utilities (CLU). It also specifies how to configure a Service Control deployment to support subscriber integration in its various forms.
This guide is intended for the system administrator and the networking or computer technician who is responsible for the on-site installation and configuration of the SM application. It is also intended for the operator who will be responsible for daily operations of the SM.
Document Revision History
The Document Revision History below records changes to this document.
Table 1 Document Revision History
|
Cisco Service Control Release and Date
|
|
OL-7199-13 |
3.5.0 February 2, 2011 |
• Updated database replication in Appendix E. • Added cross reference to the Cisco Service Control Quota Management Solution Guide in the "Related Documentation" section and updated the upgrade procedures in Chapter 4, "Installation and Upgrading.". |
OL-7199-12 |
3.5.0 February 25, 2009 |
• Updated the third bullet of the "Prerequisites" section on page 5-5 to omit the need for SCA BB installation on the SMs • Added the following note: Note Login Event Generators and the SCA BB application are now installed by default on the SM. |
OL-7199-11 |
3.5.0 January, 2009 |
• Added information about the p3rdr Utility. See Information About the p3rdr Utility, page B-19. • Login Event Generators and the SCA BB application are now installed by default on the SM. • Added new section to the configuration file to define a Collection Manager. See CM.XXX Section, page A-23. • Added information about the Quota Manager component. See Quota Management, page 2-13. • Added information about the Virtual Link Manager component. See Virtual Link Management, page 2-13. |
OL-7199-10 |
3.1.6 May, 2008 |
Small changes to correct documentation errors. |
OL-7199-09 |
3.1.5 November, 2007 |
• Changed the upgrade procedure. See Automatic Upgrade of Subscribers with VLAN Mappings, page 4-24. • Added a downgrade procedure to downgrade the version of the SM. See How to Downgrade the Subscriber Manager, page 4-41. • Changed the uninstall procedure. See How to Uninstall the Subscriber Manager, page 4-41. |
OL-7199-08 |
3.1.5 LA July, 2007 |
Added support for IPs over VPN. See Information About Handling VPNs, page 2-6, Radius.Subscriber ID Section, page A-14, How to Manage Subscribers, Mappings, and Properties (p3subs), page 5-19, Managing VPN Entities (p3vpn), page 5-21, Information About the p3subs Utility, page B-28, and Information About the p3vpn Utility, page B-36. |
OL-7199-07 |
3.1.0 May, 2007 |
• Added support for data synchronization with cascaded SCEs. See Step 2Configure the SCE platform repository, page 5-5, SCE.XXX Section, page A-18, and Working with Cascade SCE Setups, page 2-11. • Increased the number of subscribers that can be handled by the system. See Step 2Determine the system memory settings, page 4-14. • Solaris 10 now supported. See System Requirements, page 4-7. • Push and Pull mode support automatic domain roaming. See Subscriber Domains, page 2-12. • Added Redundancy Status field to output of p3net CLU. See Examples of using the p3net Utility, page B-17. • Changed the installation procedure. See Installing the Subscriber Manager, page 4-13. • Changed the upgrade procedures. See How to Upgrade the Subscriber Manager, page 4-23. • Changed the supported character set for Subscriber-Id. See Subscriber ID, page 2-5. |
OL-7199-06 |
3.0.6 January, 2007 |
• New feature added to remove inactive subscribers from the SM database. See Inactive Subscriber Removal Section, page A-11. • Updated the p3sm CLU to display information about the removal of inactive subscribers. See Information About the p3sm Utility, page B-23. |
OL-7199-05 |
3.0.5 November, 2006 |
• Changed the RPC.Server sections of the configuration file to include PRPC server security level. See RPC.Server Section, page A-17. • Changed the p3rpc CLU. See p3rpc Utility, page B-21. • Added formatting rules for the subscriber ID. See Subscriber ID, page 2-5. • Added case insensitivity to the subscriber ID. See SM General Section, page A-3. |
OL-7199-04 |
3.0.3 July, 2006 |
• Changed the upgrade procedure. See Upgrading from a Standalone Setup, page 4-25. • Updated the installation software requirements to include Red Hat 4. |
OL-7199-03 |
3.0.3 May, 2006 |
• Updated the installation software requirements to include Solaris 10 and Red Hat 4. • Updated the installation procedures to reflect removal of support for TimesTen, DSNs, and Java. • Added new section covering upgrade procedure from version 3.0 to 3.0.3. See Upgrading from a Cluster Setup Version 3.x, page 31. • Changed the procedure to uninstall VCS agents. See Uninstalling VCS Agents, page 43. • Added new sections detailing the RDR Server configuration. See RDR Server Section, page 20. • Added new section detailing MPLS-VPN configuration. See MPLS-VPN Section, page 18. • Added arguments for MPLS/VPN mappings. See How to Manage Subscribers, Mappings, and Properties (p3subs), page 19 and Information About the p3subs Utility, page 28. |
OL-7199-02 |
3.0 December, 2005 |
• Reorganized the documentation. No major changes or new features were added to this revision. • Changed the RAM and Memory Configuration Parameters Versus Number of Subscribers table. |
OL-7199-01 |
2.5.7 August, 2005 |
First version of this document. |
Organization
This guide contains the following sections:
Table 2-2 Document Organization
|
|
|
1 |
Cisco Service Control Overview, page 1-1 |
Presents an overview of the Cisco Service Control Solution and the SCE platform |
2 |
Subscriber Manager Overview, page 2-1 |
Describes the subscriber manager solution, the handling of subscribers, the fundamentals and management of the SM application |
3 |
Subscriber Manager Fail-Over, page 3-1 |
Describes topics that are related to using the subscriber manager together with clusters and redundancy |
4 |
Installation and Upgrading, page 4-1 |
Describes the installation and basic configuration procedures for the SM and how to perform an upgrade of the SM |
5 |
Configuration and Management, page 5-1 |
Describes the SM configuration and management procedures and how to use the Command-Line Utilities (CLU) |
A |
Configuration File Options, page A-1 |
Provides a description of all parameters that can be configured by using the subscriber manager configuration file |
B |
Command-Line Utilities, page B-1 |
Describes the Command-Line Utilities (CLU) that the SM uses to manage and maintain the application |
C |
CPE as Subscriber in Cable Environment, page C-1 |
Deals with the special case when the Customer Premise Equipment (CPE) is considered as the subscriber in the Cisco Service Control solution for a cable environment, such as DSL and wireless. |
D |
Troubleshooting, page D-1 |
Describes the error messages, probable causes, and solutions of the SM application |
E |
Veritas Cluster Server, page E-1 |
Provides basic guidelines for the Veritas Cluster Server configuration in an SM cluster installation |
Related Documentation
Use this Cisco SCMS Subscriber Manager User Guide in conjunction with the following Cisco documentation:
•
Cisco Service Control Application for Broadband User Guide
•
Cisco Service Control Quota Management Solution Guide
•
Cisco SCE 1000 2xGBE Installation and Configuration Guide
•
Cisco SCE 2000 4xGBE Installation and Configuration Guide
•
Cisco SCE 8000 Installation and Configuration Guide
•
Cisco SCMS SM LEGs User Guide
Conventions
This document uses the following conventions:
Table 3 Document Conventions
|
|
bold font |
Commands and keywords and user-entered text appear in bold font. |
italic font |
Document titles, new or emphasized terms, and arguments for which you supply values are in italic font. |
[ ] |
Elements in square brackets are optional. |
{x | y | z } |
Required alternative keywords are grouped in braces and separated by vertical bars. |
[ x | y | z ] |
Optional alternative keywords are grouped in brackets and separated by vertical bars. |
string |
A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks. |
courier font |
Terminal sessions and information the system displays appear in courier font. |
< > |
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. |
Note
Means reader take note.
Tip
Means 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.
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's 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 the What's 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.