|
|
Table Of Contents
Additional Management Tools and Interfaces
Information About The SCA BB Service Configuration Utility
Using the SCA BB Service Configuration Utility
SCA BB Service Configuration Utility Examples
Information About The SCA BB Real-Time Monitoring Configuration Utility
Using the SCA BB Real-Time Monitoring Configuration Utility
SCA BB Real-Time Monitoring Configuration Utility Examples
rtmcmd User Configuration File Example
Information About The SCA BB Signature Configuration Utility
Using the SCA BB Signature Configuration Utility
SCA BB Signature Configuration Utility Examples
Information About SNMP, MIB, and Traps: Overview
Installing PQI Files from the Command Line
How to Install a SCA BB PQI File on an SCE Platform
How to Install a SCA BB PQI File on an SM Device
Managing Subscribers via Other System Components
Selecting Subscribers for Real-Time Usage Monitoring
Additional Management Tools and Interfaces
•
Information About The SCA BB Service Configuration Utility
•
•
•
•
•
Information About The SCA BB Service Configuration Utility
The Cisco Service Control Application for Broadband (SCA BB) Service Configuration Utility (servconf) is a command-line utility (CLU) for applying and retrieving service configurations. Use it in a scripting environment to automate service configuration tasks on multiple Service Control Engine (SCE) platforms.
The Service Configuration Utility can run in Windows, Solaris, and Linux environments.
For installation instructions, see Installing the SCA BB Configuration Utilities.
Using the SCA BB Service Configuration Utility
The command-line syntax of the SCA BB Service Configuration Utility is:
servconf <operation>[<option>] [<option>] ...The following tables list the servconf operations and options.
SCA BB Service Configuration Utility Examples
Example 1
To copy the service configuration file config.pqb from the local machine to two SCE platforms (at 63.111.106.7 and 63.111.106.12), and activate this configuration:
servconf "--se=63.111.106.7;63.111.106.12" --username Alice --password ***** --apply --file config.pqbExample 2
To retrieve the current service configuration from the SCE platform at 63.111.106.7, and save it in file my_files\config.pqb on the local machine:
servconf -S 63.111.106.7 -U Bob -P ***** --retrieve --file my_files\config.pqbExample 3
To update the SCMS-CM at 63.121.116.17 with service configuration values from file config.pqb , as if they were applied to the SCE platform at 63.111.106.7 (but without actually applying them to the SCE platform):
servconf -D 63.121.116.17 -U Alice -P ***** --update-dc --refer-se 63.111.106.7 --file config.pqbExample 4
To distribute the protocol pack file new_signature.spqi to the SCE platforms at 10.56.216.33 and 10.56.216.36:
servconf --update-signature-pqi -f new_signature.spqi -S "10.56.216.33;10.56.216.36" -U user123 -P *****Information About The SCA BB Real-Time Monitoring Configuration Utility
SNMP-based monitoring tools, such as MRTG, allow network administrators to monitor the activity and health of network devices in real time. SCA BB includes an SNMP-based real-time monitoring solution, which is implemented using MRTG and a graphics utility (RRDTool).
The SCA BB Real-Time Monitoring Configuration Utility ( rtmcmd ) is a command-line utility (CLU) for automating the production of the files required by the MRTG tool.
For installation instructions, see Installing the SCA BB Configuration Utilities. For more information about installing and using the SCA BB SNMP-based real-time monitoring solution, see the Cisco SCA BB SNMP Real-Time Monitoring User Guide .
•
•
•
Using the SCA BB Real-Time Monitoring Configuration Utility
The command-line syntax of the SCA BB Real-Time Monitoring Configuration Utility is:
rtmcmd --sce <SCE (SNMP) addresses>{--file <PQB filename>| (--pqb-sce<SCE (PQB) addresses>--username <username>--password <password>)} --source-dir <dir>--dest-dir <dir>--config-file <file>The following table lists the rtmcmd options.
Table 13-7 rtmcmd Options
--sce address
-S
Specifies the IP address or hostname of the SCE platform from which SNMP data will be collected.
To specify multiple SCE platforms, list the IP addresses separated by semicolons.
When using a semicolon in a Unix command line, the command-line argument must be enclosed in quotation marks.
--file filename
-f
(Required if --pqb-sce is not included) Specifies the service configuration file to use when generating the configuration and report files. If this option is specified, the --username/-U and --password/-P options are prohibited.
--pqb-sce address
-q
(Required if --file is not included) Specifies the hostname or IP address of the SCE platform from which the service configuration should be retrieved. This option requires the --username/-U and --password/-P options.
--username <username>
-U
(Required if --pqb-sce is included) Specifies the username for connecting to the SCE platform.
--password <password>
-P
(Required if --username is included) Specifies the password for connecting to the SCE platform.
--source-dir <dir>
-s
Specifies the location of the report template files.
--dest-dir <dir>
-d
Specifies the directory where the processed report templates should be stored.
--config-file <file>
-c
Specifies The User Configuration File.
You can invoke additional operations to display information about the rtmcmd using the following syntax:
rtmcmd <operation>
Table 13-8 rtmcmd Operations
--version
Displays the program version number, then exits
--help
Displays help, then exits
SCA BB Real-Time Monitoring Configuration Utility Examples
Example 1
To use the service configuration file servicecfg.pqb to create configuration and report files for the collecting and reporting of SNMP information from two SCE platforms (at 63.111.106.7 and 63.111.106.12):
rtmcmd --sce="63.111.106.7;63.111.106.12" --file=servicecfg.pqb --source-dir=/rtm-templates --dest-dir=/rtm-output -c ./rtmcmd.cfgExample 2
To use the service configuration loaded on the SCE platform at 63.111.106.7 to create configuration and report files for the collecting and reporting of SNMP information from two SCE platforms (at 63.111.106.7 and 63.111.106.12):
rtmcmd -S "63.111.106.7;63.111.106.12" -U user123 -P **** --pqb-sce=63.111.106.7 --source-dir=/rtm-templates --dest-dir=/rtm-output -c ./rtmcmd.cfgThe User Configuration File
The user configuration file contains user-specific information required by the rtmcmd utility. The SCA BB utilities distribution package contains a sample configuration file, named rtmcmd.cfg. You should edit this file according to the details of your setup.
The following table lists the configuration parameters that should be present in the user configuration file:
The configuration text file is a listing of key-value pairs, where the key is one of the parameters listed above, in the following format:
•
•
•
•
For example:
# This is a comment line. # Directory names should use escape backslashes: rtm_dir=D:\\PROGRA~1\\APACHE~1\\Apache2.2\\htdocsrtmcmd User Configuration File Example
#The absolute path to the RRD tool's execution files folder #Use '\\' or '/' as path separator rrdtool_bin_dir=C:/rrdtool-1.2.15/rrdtool/Release #The absolute path where RTM files will be placed. #This path will be used by MRTG to create and update the RRD files #Note: path must not contain white spaces! rtm_dir=C:/PROGRA~1/APACHE~1/Apache2.2/htdocs #The absolute path to the MRTG bin folder. #This path will be used to create file crontab.txt mrtg_bin_dir=C:/mrtg-2.14.5/bin #The SCE's community string snmpCommunityString=publicInformation About The SCA BB Signature Configuration Utility
The SCA BB Signature Configuration Utility ( sigconf ) is a command-line utility for installing and managing the default DSS.
The Signature Configuration Utility can run in Windows, Solaris, and Linux environments.
For installation instructions, see Installing the SCA BB Configuration Utilities.
Using the SCA BB Signature Configuration Utility
The command-line syntax of the SCA BB Signature Configuration Utility is:
sigconf <operation>[--file <filename>]The following tables list the sigconf operations and options.
Table 13-11 sigconf File Option
--file= filename
-f
Specifies DSS file
SCA BB Signature Configuration Utility Examples
Example 1
To install the file new_signature.dss as the default DSS:
sigconf --set-default-dynamic-signature --file new_signature.dssExample 2
To retrieve the installed default DSS file, and save it as default_backup.dss :
sigconf --get-default-dynamic-signature --file default_backup.dssInformation About SNMP, MIB, and Traps: Overview
Cisco provides complete network FCAPS (Fault, Configuration, Accounting, Performance, Security) Management.
Two interfaces are provided for network management:
•
•
SNMP
SNMP is a set of protocols for managing complex networks. SNMP works by sending messages, called protocol data units (PDUs), to different parts of a network. SNMP-compliant devices, called agents, store data about themselves in Management Information Bases (MIBs) and return this data to the SNMP requesters.
The SCE platform operating system includes an SNMP agent. Configuring the SNMP agent parameters and enabling the SNMP interface is described in the "Configuring the Management Interface and Security" chapter of the Cisco Service Control Engine (SCE) Software Configuration Guide .
MIB
Management Information Bases (MIBs) are databases of objects that can be monitored by a network management system. SNMP uses standardized MIB formats that allow standard SNMP tools to monitor any device defined by a MIB.
The SCE platform supports the following MIBs:
•
•
Traps
Traps are unsolicited messages generated by the SNMP agent that resides inside the SCE platform. Traps are generated when an event occurs. When the Network Management System receives the trap message, it can take suitable actions, such as logging the occurrence or ignoring the signal.
The SCE platform supports two general categories of traps:
•
•
For a description of the SNMP traps and an explanation of how to configure the SNMP trap managers, see "SNMP Configuration and Management" in the "Configuring the Management Interface and Security" chapter of the Cisco Service Control Engine (SCE) Software Configuration Guide .
Installing PQI Files from the Command Line
•
•
How to Install a SCA BB PQI File on an SCE Platform
You can install a SCA BB PQI file on an SCE platform using the SCE platform Command-Line Interface (CLI).
Step 1
•
•
Step 2
Step 3
The SCE(config)# prompt appears.
Step 4
Step 5
The SCE(config if)# prompt appears.
Step 6
Step 7
The PQI file is now installed.
Note
How to Install a SCA BB PQI File on an SM Device
You can install a SCA BB PQI file on a Cisco Service Control Management Suite (SCMS) Subscriber Manager (SM) using the SM Command-Line Utility (CLU).
Step 1
Step 2
Step 3
Step 4
Step 5
The PQI file is now installed.
Note
Managing Subscribers via Other System Components
Other components of the Cisco Service Control solution offer alternatives for subscriber management (as opposed to using the Subscriber Manager GUI tool in the Console):
•
•
This section gives an overview of these alternatives, with emphasis on the SCA BB-specific subscriber management options. For in-depth explanations, see the appropriate Service Control documentation.
Anonymous Subscriber Mode
An anonymous subscriber is one with a name generated automatically by the SCE platform according to an anonymous subscriber group specification. An anonymous subscriber is always mapped to a single IP address. The actual identity of the customer is unknown to the system. (See Information About Subscribers and Subscriber Modes.)
An anonymous group is a specified IP range, possibly assigned a subscriber template. If an anonymous group is configured, the SCE platform generates anonymous subscribers for that group when it detects traffic with an IP address in the specified IP range. If a subscriber template is assigned to the group, the anonymous subscribers generated have properties defined by that template. If no subscriber template is assigned, the default template is used, which cannot be changed by template import operations. Initially, 32 templates are preconfigured, one for each package ID.
Anonymous subscriber groups and subscriber templates are managed using the SCE platform Command-Line Interface (CLI). You can enter CLI commands via a Telnet session. For more information, see the Cisco Service Control Engine (SCE) CLI Command Reference .
Use the following commands to import anonymous subscriber groups and subscriber templates from CSV files and to export subscriber data to these files:
•
subscriber anonymous-group import csv-file•
subscriber anonymous-group export csv-file•
subscriber template import csv-file•
subscriber template export csv-file
Note
SCE(config if)#prompt displayed before entering a command.Use the following commands to delete anonymous groups or subscriber templates from the system.
•
no subscriber anonymous-group [all] [name <groupname>]•
clear subscriber anonymous•
default subscriber template all
Note
SCE(config if)#prompt displayed before entering a command.Use the following commands to display anonymous subscriber information:
•
show interface LineCard 0 subscriber templates [index]•
show interface LineCard 0 subscriber anonymous-group [all] [name <groupname>]•
show interface LineCard 0 subscriber amount anonymous [name <groupname>]•
show interface LineCard 0 subscriber anonymous [name <groupname>]Selecting Subscribers for Real-Time Usage Monitoring
Real-Time Subscriber Usage RDRs report the network activity of a single subscriber per service per metric, in real-time. You must enable the generation of these subscriber usage RDRs separately for each subscriber that you wish to monitor.
Generating and collecting Real-Time Subscriber Usage RDRs for many subscribers can compromise performance. Enable Real-Time Subscriber Usage RDR generation only for subscribers that must be monitored.
Generation of Real-Time Subscriber Usage RDRs is controlled by the monitor subscriber property. By default, generation of these RDRs is disabled (monitor = 0). To enable generation of the RDRs, change the value of the property to 1.
You can modify this property for selected subscribers using either the SM Command-Line Utility (CLU) or the SCE platform CLI.
Managing Subscriber Monitoring via the SM
You can enable or disable the generation of the Real-Time Subscriber Usage RDRs using the SM p3subs utility. You can also create a file that processes a batch of subscribers. For more information, see the Cisco Service Control Management Suite Subscriber Manager User Guide .
•
•
•
•
How to enable subscriber monitoring for subscriber Smith
Step 1
sm/server/bin/p3subs --set --subscriber Smith --property monitor=1
How to disable subscriber monitoring for subscriber Smith
Step 1
sm/server/bin/p3subs --set --subscriber Smith --property monitor=0
How to enable subscriber monitoring for a group of subscribers
Step 1
p3subs --set --subscriber Jerry --property monitor=1 p3subs --set --subscriber George --property monitor=1 p3subs --set --subscriber Elaine --property monitor=1 p3subs --set --subscriber Kramer --property monitor=1 p3subs --set --subscriber Newman --property monitor=1Step 2
sm/server/bin/p3batch -f monitor.txt
To see whether subscriber monitoring is enabled for subscriber Smith
You can check to see whether subscriber monitoring is enabled for a specific subscriber.
Step 1
sm/server/bin/p3subs --show-property --subscriber Smith --property monitor
Managing Subscriber Monitoring via the SCE Platform
You can also enable or disable the generation of the Real-Time Subscriber Usage RDRs using the SCE platform. For more information, see the Cisco Service Control Engine (SCE) CLI Command Reference .
(The prompt is included in these examples to illustrate how it changes. You must see the
SCE(config if)#prompt to invoke the actual subscriber command.)•
•
•
•
How to enable subscriber monitoring for subscriber "Smith"
Step 1
SCE# configureSCE(config)# interface LineCard 0SCE(config if)# subscriber name Smith property monitor value 1How to disable subscriber monitoring for subscriber "Smith"
Step 1
SCE# configureSCE(config)# interface LineCard 0SCE(config if)# subscriber name Smith property monitor value 0How to enable subscriber monitoring for a group of subscribers
Step 1
configure interface LineCard 0 subscriber name Jerry property monitor value 1 subscriber name George property monitor value 1 subscriber name Elaine property monitor value 1 subscriber name Kramer property monitor value 1 subscriber name Newman property monitor value 1Step 2
SCE# script run monitor.txtHow to see whether subscriber monitoring is enabled for subscriber "Smith"
Step 1
SCE# show interface LineCard 0 subscriber name Smith propertiesThe properties are displayed; monitor is the relevant parameter.
Subscriber smith properties: subscriberPackage=0 monitor=1 Subscriber 'smith' read-only propertiesSubscriber-Aware Mode
In subscriber-aware mode, each subscriber is a specific customer with an externally generated name. This externally generated name allows the subscriber to be mapped to more than one IP address and still be identified. Each traffic session (single IP flow, or a group of related IP flows) processed by the SCE platform is assigned to a recognized subscriber on the basis of the configured subscriber mappings.
There are three options for introducing and managing these subscribers:
•
•
SCE Platform Subscriber CLI
Use the following commands to import subscriber data from CSV files and to export subscriber data to these files:
•
subscriber import csv-file•
subscriber export csv-file
Note
SCE(config if)#prompt displayed before entering a command.Use the following command to remove subscribers from the system.
•
no subscriber [all] [name <subscriber-name>]
Note
SCE(config if)#prompt displayed before entering a command.Use the following commands to display subscribers meeting various criteria:
•
show interface LineCard 0 subscriber [amount] [prefix <prefix>] [property <propertyname>equals|greater-than|less-than <property-val>]•
show interface LineCard 0 subscriber [amount] prefix <prefix>•
show interface LineCard 0 subscriber [amount] suffix <suffix>•
show interface LineCard 0 subscriber mapping IP <iprange>•
show interface LineCard 0 subscriber mapping VLANid <vlanid>Use the following commands to display information about a specific subscriber:
•
show interface LineCard 0 subscriber properties•
show interface LineCard 0 subscriber name <name>•
show interface LineCard 0 subscriber name <name>mappings•
show interface LineCard 0 subscriber name <name>counters•
show interface LineCard 0 subscriber name <name>propertiesUsing the SM CLU to manage subscribers
Use the p3subs SM utility to manage subscribers. You can add or remove subscribers. You can also manage subscriber properties and mappings with this utility.
Step 1
p3subs <operation>--subscriber=<Subscriber-Name>[--ip=<IP-address>] [--property=<property-name=value>] [--domain=<domain-name>] [--overwrite]The following table lists the p3subs operations relevant to managing subscribers.
Managing CSV Files
Use the p3subsdb SM utility to import and export subscriber CSV files. You can import subscriber information for a group of subscribers from a CSV file into the SM database. You can also export subscriber information from the SM database to a CSV file.
For more information, see the Cisco Service Control Management Suite Subscriber Manager User Guide .
CSV file structure is described in the "CSV File Formats" chapter of the Cisco Service Control Application for Broadband Reference Guide .
How to import CSV files:
Step 1
p3subsdb --import filename
How to export CSV files:
Step 1
p3subsdb --export filename
To export subscribers with filtering options to a specified CSV file:
p3subsdb --export --prefix=a --output=silverSubscriberFile.csv
Posted: Wed May 30 12:17:31 PDT 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.
