Subscriber Manager GUI Tool
This chapter describes
how to use the Subscriber Manager (SM) graphical user interface (GUI) tool to
configure subscribers in the Cisco Service Control SM database.
The SM GUI tool is
especially useful when the Cisco Service Control SM holds a static list of
subscribers. It is not applicable when Cisco SCA BB is operating in
subscriberless mode (a mode in which control and analysis functions are
available only at a global platform resolution) or in anonymous subscriber mode
(a mode in which entities defined as IP addresses or VLANs are treated as
subscribers). This chapter consists of these sections:
Subscriber Manager GUI Tool Overview
This chapter describes how to use the Subscriber Manager (SM) graphical
user interface (GUI) tool to configure subscribers in the Cisco Service Control
The SM GUI tool is especially useful when the Cisco Service Control SM
holds a static list of subscribers. It is not applicable when Cisco SCA BB is
operating in subscriberless mode (a mode in which control and analysis
functions are available only at a global platform resolution) or in anonymous
subscriber mode (a mode in which entities defined as IP addresses or VLANs are
treated as subscribers).
The SM GUI tool allows you to manage subscribers on a Cisco Service
Control SM. The Cisco Service Control SM functions as middleware software that
bridges between the OSS and the Cisco Service Control Engine (Cisco SCE)
platforms. Cisco SCE platforms use the subscriber information to provide
subscriber-aware functionality, per-subscriber reporting, and policy
enforcement. Subscriber information is stored in the Cisco Service Control SM
database and can be distributed between multiple platforms according to actual
You can use the SM GUI tool to import and export subscriber files, and
to perform operations on individual subscribers, such as:
- Add and delete a subscriber
- Edit parameters and show
data of an existing subscriber
- Add and remove subscriber
- Import subscribers from a CSV file
- Export subscribers to a CSV file
- Find subscriber or subscribers in a certain domain (filter)
To access a Cisco Service Control SM from the SM GUI tool, you must
first add the Cisco Service Control SM to the Site Manager tree in the Network
Navigator tool (see “How to Add Subscriber Manager Devices to a Site” section).
The SM GUI tool provides only a subset of the functionality that the SM
Command-Line Utility provides. For more information about the Cisco Service
Control SM, see the Cisco Service Control Management Suite Subscriber Manager
Connecting to a Cisco Service Control Subscriber Manager Overview
You can connect to a Cisco Service Control Subscriber Manager:
- From the Network Navigator tool
- From anywhere else in the Console
- From the Subscriber Manager GUI tool
The SM GUI tool performs authentication on the Cisco Service Control Subscriber Manager by opening a
PRPC connection to port 14374 and attempting to log in using the username and password
that you entered in the Password Management dialog box. If a PRPC server with this user
is not running on the Cisco Service Control Subscriber Manager, authentication fails. If you have
changed the PRPC port on the Cisco Service Control Subscriber Manager, see “User Authentication” section.
Connecting to a
Cisco Service Control Subscriber Manager from the Network Navigator
||In the Site
Manager tree in the Network Navigator tab, right-click an SM device.
Figure 1. SM Device
||From the menu,
Password Management dialog box appears.
|| Enter the
information, see the “Password Management” section.
Password Management dialog box closes. A Connecting to progress bar appears.
connects to the Cisco Service Control Subscriber Manager.
Connecting to a
Cisco Service Control Subscriber Manager from the Console
the Current Cisco Service Control Subscriber Manager
Because of the large
number of subscribers that must be introduced into the system, it is not
feasible to enter subscriber information manually. Usually a RADIUS server (or
some similar source) generates the subscriber information. This information is
then imported into the Subscriber Manager GUI tool.
You can also export
updated subscriber information to a CSV file.
The format of
subscriber CSV files is described in the “CSV File Formats” chapter of Cisco
Service Control Application for Broadband Reference Guide.
Subscriber Information from a CSV File
You can import subscriber
data that was exported to a CSV file into the Subscriber Manager GUI tool.
Before You Begin
Confirm that the
subaware.pro file in the Cisco Service Control Subscriber Manager is configured
to import the required type of subscribers—IPv4 subscribers or IPv4 and IPv6
subscribers. If required, make necessary changes to subaware.pro file. For more
details on configuring the subaware.pro file, see the Cisco Service Control
Management Suite Subscriber Manager User Guide.
||In the SM GUI
toolbar, click the Import subscribers from CSV file ()
from File dialog box appears.
||Browse to the
file that is to be imported and click Open.
Warning message appears.
Figure 5. Import
Import from File dialog box closes.
The selected file is imported into
the SM GUI tool; the imported subscribers are listed in the subscriber list.
Subscriber Information to a CSV File
You can export subscriber
information to a CSV file (for example, when data in the Cisco Service Control
SM database is updated).
subscribers whose data you want to save.
“Selecting Subscribers” section.
||In the SM
toolbar, click the Export subscribers to CSV file
to File dialog box appears.
||Browse to the
folder in which you want to save the exported file.
||In the File name
field, enter a file name.
Export to File dialog box closes.
subscribers are saved to the CSV file.
subscribers into the system, you can maintain and update the database.
You can perform the
In the SM GUI, you can
see a list of all the subscribers currently introduced into Cisco SCA BB. Use
this list to manage individual subscribers or groups of subscribers. Use the
Find function to display a subset of the subscribers (see
“Finding a Subscriber or
Group of Subscribers” section).
The SM GUI is composed
of a console view at the bottom and a device view at the top. The console shows
the log messages. The device view has the following columns:
Figure 6. Subscriber
Manager GUI - Subscriber List
- Subscriber ID—Name of the
subscriber in the system.
- Domain—Domain to which the
subscriber is assigned. The names of the Cisco SCE platforms that belong to
each domain appear in square brackets.
- Network Mappings—IP address,
range of IP addresses, or VLAN tag mapped to the subscriber.
properties assigned to the subscriber (Package ID, Monitor State, Up Vlink ID,
Down Vlink ID).
If you enable the
Package-ID to Package-Name Mapping check box in the Preferences
page, the package name is displayed along with the package ID for the
subscriber, based on the last policy updated in the domain. For more
information on enabling the Package-ID to Package-Name Mapping, see the
Manager GUI - Preferences Page .
- Custom Properties—Displayed
as key value pairs.
Table 1 SM GUI Icon
subscribers (if enabled).
subscribers to CSV file.
subscribers from CSV file.
status (opens SM online status window).
Connect to an
list of subscribers.
By right-clicking on a
specific subscriber, you can perform various actions, including:
Figure 7. Subscriber
Manager GUI - Subscriber Online Status
- Edit subscriber data.
- Delete the subscriber.
- Display the online status of
the subscriber, including:
- Expiration or aging time (if
- Number of concurrent
- Reported block actions
- Number of concurrent active
- Quota status (if any)
- Subscriber OS information
- View information on multiple
subscriber in multiple windows.
From the menu bar, you
can select and open the Preferences page. When the Subscriber Manager is
selected in the left pane, you can do the following:
- Specify the number of
subscriber records to be listed in the main display table.
- Enable or disable the
“Remove All Subscribers” functionality.
- Enable or disable the
enhanced subscriber data mode; if enabled, the Up Vlink ID and Down Vlink ID
columns are displayed in the table.
Figure 8. Subscriber
Manager GUI - Preferences Page
- Enable or disable
Package-ID to Package-Name Mapping; if enabled, the package name is displayed
along with the package ID for the subscriber.
Overview of How to
Find and Select Subscribers
The SM GUI tool
retrieves subscribers in bulks of 1000 subscribers.
If the number of
subscribers are more than that can be displayed in a standard view, then the
information is presented in multiple pages. You can navigate to the remaining
groups of subscribers using the various pagination buttons.
Figure 9. Subscriber
Manager GUI - Pagination Buttons
- 1. Get previous bulk.
- 2. Get first page.
- 3. Get previous
- 4. Enter page
- 5. Get next page.
- 6. Get last page.
- 7. Get next bulk.
For ease of use, the
SM GUI tool incorporates two standard features:
- Find—Search for a
Select—Select a range of subscribers or a number of individual subscribers.
Subscriber or Group of Subscribers
Use the Find feature to find
a specific subscriber or a group of subscribers according to a subscriber ID
prefix. This feature is useful for editing the parameters of either a specific
subscriber or a group of subscribers (see “Editing Subscriber Details” section.
||In the Find
field enter the prefix to be matched.
Figure 10. Find
||Click the Find
Subscribers () icon.
You see a list
of only the subscribers that match the specified prefix.
criteria is selected in the drop-down list next to the Find field. Search by:
- Domain name
- Package ID
You can edit, export,
or delete a group of subscribers at one time by selecting subscribers displayed
in the subscriber list. The group may be either of the following:
Selecting a Range of Subscribers
|| Select the first subscriber in the range. |
||Press the Shift key while clicking the last subscriber in the range. You can combine this function with the search function; search for specific
subscribers and then select the entire range. All subscribers within the range are selected.|
Selecting a Number of Noncontiguous Subscribers
| Press the Ctrl key while selecting multiple subscribers.
You can combine this function with selecting a range of
subscribers; first, select the range of subscribers, and then select additional
Adding a Subscriber
You can add additional
individual subscribers to the Cisco Service Control Subscriber Manager. To add
large number of subscribers, export their information from a RADIUS (or DHCP)
server to a CSV file, and then import the CSV file. For details on importing
the CSV files, see “Working with Subscriber CSV Files” section.
||In the SM GUI
toolbar, click the Add Subscriber ()
The Add a
New Subscriber dialog box appears.
Figure 11. Add a New
Subscriber ID field, enter text that identifies the subscriber.
Subscriber Domain drop-down list, select the appropriate domain for the new
Subscriber Package drop-down list, select a package to assign to this
The contents of
the list depend on the selected subscriber domain.
subscriber real-time monitoring, check the Activate Subscriber Real-time
Monitoring check box.
the “monitor” property to 1 and causes the Cisco SCE application to generate
Real-Time Subscriber Usage RDRs for this subscriber.
subscriber network mappings. If you are not going to define network mappings
for this subscriber, continue at Step 10.
supports either IP addresses or VLAN tags as network identification for
subscribers. The Cisco Service Control solution supports an IP prefix range of
0 to 32 for IPv4 addresses and 32 to 34 for IPv6 addresses. Select one of the
Subscriber Network Mappings radio buttons:
|| We recommend
that you do not assign the same IPv6 address to different subscribers with
different prefix values.
icon to add a network mapping of the type selected.
network-mapping entry is added to the subscriber network mappings list,
displaying a default value
|| Edit the
|| Repeat Steps 7
and 8 for other network mappings.
|| Click OK .
The Add a
New Subscriber dialog box closes.
subscriber is added to the database and joins the subscriber list displayed in
the SM GUI tool.
Subscriber from the Database
You can delete subscribers
from the database.
||Select a single
subscriber or a group of subscribers.
“Selecting Subscribers” section.
||In the SM
toolbar, click the Delete Subscriber ()
The system asks
for confirmation before deleting the selected subscribers.
||Click Yes to
subscribers are deleted from the database and removed from the subscriber list
displayed in the SM GUI tool.
The SM online status window
provides real-time status of the SM operation by displaying the main properties
of the SM.
Figure 14. SM Online
|To open the SM
Online Status window, click on the Open () icon in the
main GUI toolbar.
are grouped in the toolbar at the upper right corner of the SM Online Status
Table 2 SM Online
Status Window Icon Descriptions
Autorefresh , the drop-down list shows selectable time interval options
(default 30 seconds)
all properties and values to the clipboard (or right-click a single property to
on top (enable or disable place status window on top of other windows)