Cisco Service Control Application for Broadband User Guide, Release 4.1.x

Getting Started

Introduction

The module guides you through the process of installing or upgrading the Cisco SCA BB:

•Describes the concept of the Console as a collection of tools, presents each tool and its role. This module also describes how to launch the tools and navigate between these tools.

•Explains how to install Protocol Packs, which contain new and updated protocol signatures

•Concludes with a QuickStart that describes how to apply your first service configuration and generate your first report

This section consists of the following sections:

•How to Install Cisco SCA BB

•How to Upgrade Cisco SCA BB Components

•Working with Protocol Packs

•How to Launch the Console

•How to Use the Console

•QuickStart with the Console

How to Install Cisco SCA BB

Note The Cisco SCA BB application can only be installed in the administrator user group of Windows XP. During installation the Cisco SCA BB application changes registry entries, therefore installation in normal user groups is not allowed. The installer must have administrator privileges assigned.

You install Cisco SCA BB in two stages:

1. Install the Cisco SCA BB front ends:

–The Cisco SCA BB Console

–The Cisco SCA BB Service Configuration Utility, the Cisco SCA BB Signature Configuration Utility, and the Cisco SCA BB Real-Time Monitoring Configuration Utility

2. Install the Cisco SCA BB application components:

–The Cisco SCA BB Service Modeling Language Loadable Image (SLI) and the Cisco SCA BB Service Control Engine (Cisco SCE) applicative management plug-in

–The Cisco SCA BB Subscriber Manager applicative management plug-in (for systems with a Cisco Service Control Subscriber Manager)

If you are upgrading an existing installation of Cisco SCA BB, see "How to Upgrade the SCE Using the SCE Software Upgrade Wizard" section or "Working with Protocol Packs" section.

The Cisco SCA BB Installation Package

The Cisco SCA BB installation package is a ZIP file located in the CCO.

The installation package consists of the following files:

•The installer for the Console: scas-bb-console-<version>-<build>.exe.

•A Cisco installation application package file (PQI file) for each type of Cisco SCE platform. Each PQI file is located in a subfolder whose name is the platform name.

•The file scas_bb_util.tgz, which contains the files for the Cisco SCA BB Service Configuration Utility (servconf), the Cisco SCA BB Signature Configuration Utility (sigconf), the Cisco SCA BB Real-Time Monitoring Configuration Utility (rtmcmd) (together with real-time monitoring report templates), and the BGP Autonomous System Dynamic Detection scripts and files (routerInfo.properties, asFetch.bat, asFetch.sh).

•The file PCubeEngageMib.mib, which defines the SCAS BB MIB, located in the SNMP subfolder.

•The Cisco SCA BB Service Configuration Java API distribution file: serviceconfig-java-api-dist.tgz.

•The file surfcontrol.xml, which lists the content categories for content filtering using SurfControl Content Port Authority, located in the URL Filtering subfolder.

Installing Cisco SCA BB Application Components

Cisco SCA BB has two software components that reside on the Cisco SCE platform:

•The Cisco SCA BB SLI, which performs traffic processing

•The Cisco SCA BB SCE applicative management plug-in, which performs some service configuration operations

Cisco SCA BB also has one software component that resides on the Subscriber Manager device:

•The Cisco SCA BB Subscriber Manager applicative management plug-in, which performs some application-specific subscriber management operations

To install these components from the Console, see "How to Install PQI Files on Cisco SCE Devices" section and Managing Collection Manager Devices.

To install these components from a command line, see "Installing PQI Files from the Command Line" section.

Prerequisites

Before installing Cisco SCA BB, verify that the SCE platform and, if used, the Cisco Service Control Subscriber Manager are operational and are running appropriate versions of their software.

•How to Verify that the SCE Platform is Operational

•How to Verify that the SCE Platform is Running an Appropriate Version of the OS

•How to Verify that the Subscriber Manager is Correctly Installed

•How to Verify that an Appropriate Version of the Subscriber Manager is Running

How to Verify that the SCE Platform is Operational

Step 1 Verify that the status LED on the SCE flashes green. (Orange—booting up; flashing orange—warning; red—failure.)

How to Verify that the SCE Platform is Running an Appropriate Version of the OS

Step 1 At the SCE platform CLI prompt (SCE#), type show version.

Step 2 Press Enter.

The response shows the version of the OS running on the SCE platform.

How to Verify that the Subscriber Manager is Correctly Installed

Step 1 Open a Telnet session to the Subscriber Manager.

Step 2 Go to the Subscriber Manager bin directory and type p3sm --sm-status.

Step 3 Press Enter.

The response to this command displays the operational status of the Subscriber Manager.

How to Verify that an Appropriate Version of the Subscriber Manager is Running

Step 1 Open a Telnet session to the Subscriber Manager.

Step 2 Go to the Subscriber Manager bin directory and type p3sm version.

Step 3 Press Enter.

The response to this command displays the Subscriber Manager version.

How to Install Cisco SCA BB Front Ends

You should install the following Cisco SCA BB front ends:

•The Console

•The Cisco SCA BB Service Configuration Utility (servconf), the Cisco SCA BB Signature Configuration Utility (sigconf), and the Cisco SCA BB Real-Time Monitoring Configuration tool (rtmcmd) (together with associated real-time monitoring report templates)

–servconf requires access to the Java Runtime Environment (JRE) (see "Installing the Java Runtime Environment" section).

Hardware Requirements

•At least 1024-MB RAM is required to run the Console.

•The minimal supported screen resolution for the Console is 1024x768 pixels.

Operating System Requirements

The Cisco GUI front end can be installed on any computer running Windows 2000, Windows XP, Windows Vista, or Windows 7.

Installing the Java Runtime Environment

The Cisco SCA BB Service Configuration Utility, servconf, requires access to JRE version 1.6 update 43.

To verify that the JRE is installed, run java -version from the command prompt. The Java version should start with 1.6.

If a different version of JRE is also installed on the workstation, you may need to tell servconf where to find the appropriate JRE. Do this by setting the JAVA_HOME environment variable to point to the JRE 1.6 installation directory. For example:

JAVA_HOME=C:\Program Files\Java\jre1.6.0_43

How to Install the Console

Step 1 Navigate to the Console installation file on your local machine, sca-bb-console-4.1.x.exe, and double-click it.

The Welcome page of the Cisco SCA BB Console 4.1.x Setup wizard appears.

Step 2 Click Next.

The Install Location page of the Setup wizard opens.

Step 3 (Optional) Click Browse and choose a different destination folder.

Step 4 Click Next.

The Start Menu Folder page of the Setup wizard opens.

Step 5 (Optional) Enter a different Start Menu folder in the Start Menu Folder field.

Step 6 (Optional) Check the Do not create shortcuts check box.

Step 7 Click Install.

The Installing page of the Setup wizard opens.

Step 8 Wait until the installation is complete.

The Next button is enabled.

Step 9 Click Next.

The Installation Complete page of the Setup wizard opens.

Step 10 To launch the Console, check the Run SCA BB Console after installation check box.

Step 11 Click Finish.

The Cisco SCA BB Console 4.1.x Setup wizard closes.

The Console is now installed on the machine.

A shortcut is added to the Start menu.

How to Install the Cisco SCA BB Configuration Utilities

Step 1 From the Cisco SCA BB installation package, extract the scas_bb_util.tgz file, and copy it to a work station having Windows, Solaris, or Linux operating system.

Step 2 Unpack the file to a new folder. The Cisco SCA BB Service Configuration Utility (servconf), the Cisco SCA BB Real-Time Monitoring Configuration Utility (rtmcmd) (and associated real-time monitoring report templates), the Cisco SCA BB Signature Configuration Utility (sigconf), and the BGP Autonomous System Dynamic Detection scripts and files (routerInfo.properties, asFetch.bat, asFetch.sh) are located in the bin folder. This folder also stores the BGPRouter<number>.csv file generated by the asFetch.bat script after fetching the BGP AS information from the router.

How to Upgrade Cisco SCA BB Components

Upgrading Cisco SCA BB includes upgrading each of these software components:

•SCE Firmware

•The SCE PQI file

•Protocol Pack SPQI file

•Policy file

Note This section describes the upgrade of Cisco SCA BB application components only. For a full description of the entire Cisco solution upgrade procedure, consult the solution upgrade document accompanying the formal release.

•When you upgrade old PQB files, some protocol IDs are changed automatically. Messages such as the following may be displayed to indicate the change:

Protocol ID of BaiBao changed from 80 to 43 
Protocol ID of PPLive changed from 81 to 44

•When you upgrade a device with a new SPQI or PQI file, all other devices that are not upgraded may fail.

•New Cisco SCA BB releases do not use the default Dynamic Signature Script (DSS) file (see that it was installed for a previous Cisco SCA BB release).

•If a protocol pack for the new release is available, install it after the product installation is complete. Do not install an old protocol pack on top of a new product installation.

How to Upgrade the SCE Using the SCE Software Upgrade Wizard

You can upgrade the SCE using the Network Navigator Tool via the SCE Software Upgrade wizard.

Step 1 Open the Network Navigator.

Step 2 Choose one or more devices in the Site Manager tree.

Step 3 Right-click one of the selected devices.

Step 4 From the popup menu that appears, choose SCE Software Upgrade wizard.

The SCE Software Upgrade wizard appears (see Figure 4-1).

Figure 4-1 SCE Software Upgrade

Step 5 Click Next.

The SCE IP Addresses page of the SCE Software Upgrade wizard opens (see Figure 4-2).

Figure 4-2 SCE IP Address

Step 6 (Optional) In the edit box, enter additional IP addresses.

Step 7 Click Next.

The SCE Usernames and Passwords page of the SCE Software Upgrade wizard opens (see Figure 4-3).

Figure 4-3 SCE Usernames and Passwords

Step 8 Enter the usernames and passwords for the SCE devices.

Do one of the following:

•To use the same username and password for all the SCE devices that you are adding, enter the username in the Username field and the password in the Password field.

•To provide a different username and password pair for each SCE device, click the Use separate usernames and passwords for each SCE platform radio button, and, for each SCE device, enter the username and password in the appropriate cell of the table.

Step 9 Click Next.

The Connectivity Test page of the SCE Software Upgrade wizard opens (see Figure 4-4).

Figure 4-4 Connectivity Test

The wizard tests to see that the connections to the defined devices can be made.

Note If a connection to one or more of the devices cannot be made or if there is some problem with the connection (such as invalid version of the device) an error is displayed next to the device. You can skip these tests by clicking Skip connectivity test. The connections are validated when you click Finish at the end of the wizard.

Step 10 Click Next.

The SCE Firmware (PKG) Installation page of the SCE Software Upgrade wizard opens (see Figure 4-5).

Figure 4-5 SCE Firmware (PKG) Installation

Choose the SCE Firmware installation file.

Do one of the following:

•To install SCE Firmware from a local file, click Browse.

A Select file dialog box appears.

Browse to the SCE Firmware installation file that you are installing.

Check the Use local FTP server check box to reduce the disk space usage.

•To download SCE Firmware from a remote site, choose the Install SCE Firmware from a Remote File (FTP) radio button and in the FTP URL field, enter the URL.

Step 11 Click the Skip SCE Firmware Installation radio button.

Step 12 Click Next.

The SCE Application Software (PQI) Installation page of the SCE Software Upgrade wizard opens (see Figure 4-6).

Figure 4-6 SCE Application Software (PQI) Installation

Step 13 Choose the PQI installation file.

Do one of the following:

•To install the PQI file from a local file, click Browse.

A Select file dialog box appears.

Browse to the PQI file that you are installing.

Check the Use local FTP server check box to reduce the disk space usage.

•To download a PQI file from a remote site, choose the Install SCE Application Software from a Remote File (FTP) radio button and in the FTP URL field, enter the URL.

Click the Skip SCE Software Application Installation radio button.

Step 14 Click Next.

The Protocol Pack (SPQI) Update page of the SCE Software Upgrade wizard opens (see Figure 4-7).

Figure 4-7 Protocol Pack (SPQI) Update

Step 15 Update the protocol pack.

Do one of the following:

•To update the SPQI file from a local file, click Browse.

A Select file dialog box appears.

Browse to the SPQI file that you are updating.

•Click the Skip Protocol Pack Update radio button.

Step 16 Click Next.

The Service Configuration (PQB) Update page of the SCE Software Upgrade wizard opens (see Figure 4-8).

Figure 4-8 Service Configuration (PQB) Update

Step 17 Choose one of the PQB update options.

•Apply the Current Service Configuration—Keep the existing service configuration.

•Apply the Default Service Configuration—Apply the default service configuration delivered with the product.

•Apply the Service Configuration from a Local File—Apply a service configuration from a local file.

Step 18 If you selected the Apply the Service Configuration from a Local File radio button, click Browse.

A Select file dialog box appears.

Browse to the file containing the service configuration.

Step 19 Click Next.

The Connectivity Test window of the SCE Software Upgrade wizard opens (see Figure 4-9).

The connectivity test verifies the connections to the defined devices.

Note If a connection to one or more of the devices cannot be made or if there is some problem with the connection (such as invalid version of the device), an error is displayed next to the device. You can skip these tests by clicking Skip connectivity test. The connections are validated when you click Finish at the end of the wizard.

Figure 4-9 Connectivity Test

Step 20 Click Next.

The Confirmation page of the SCE Software Upgrade wizard opens (see Figure 4-10).

Figure 4-10 Summary Page

The actions that the wizard is about to take are listed on the page.

Step 21 Click Finish.

You can view the progress in the Progress view (see Figure 4-11).

Figure 4-11 Progress

Working with Protocol Packs

Cisco SCA BB uses stateful Layer 7 capabilities for classification of traffic flows.

When the system handles a traffic flow, the flow is assigned a signature ID according to the set of Layer 3 to Layer 7 parameters (the signature) characterizing this flow. Typically, these signatures come embedded in Cisco SCA BB.

To enable rapid response to the ever-changing protocol environment, Cisco SCA BB was enhanced to allow signatures to be updated dynamically. You can load a protocol support plug-in onto an operational system, enhancing the protocol support of the system without compromising the stability of the system (no update of an existing software component is required) and without any service downtime.

•Protocol Packs

•Installing Protocol Packs

•Installing the Service Hierarchy Tree

•How to Verify Version Compatibility for Protocol Packs

•How to Verify the Installation of a Protocol Pack

•Hitless Upgrade of the SLI

Protocol Packs

Periodically, Cisco publishes protocol packs containing new and improved protocol signatures for Cisco SCA BB. A typical protocol pack is a file containing signatures for detecting network worms, popular peer-to-peer applications, and other relevant protocols. When loaded into SCE platforms, these signatures improve Cisco SCA BB classification abilities.

Note You can install a protocol pack on an SCE platform only if a PQI is already installed on the platform.

A protocol pack for Cisco SCA BB may be either a DSS file or an SPQI file:

•Loading a DSS file to the SCE platform requires no downtime of Cisco SCA BB or the platform.

•Loading an SPQI file to the SCE platform entails updating the SCE application:

–If hitless upgrade (see "Hitless Upgrade of the SLI" section) is enabled, there is no downtime of the SCE platform when loading the SPQI file.

–If hitless upgrade is not enabled, loading an SPQI file requires a short downtime (up to one minute) of the SCE platform. During that time, network traffic bypasses the platform and is neither controlled nor reported.

Note If hitless upgrade is disabled, SPQI installation can cause the loss of the following subscriber data from all subscribers: package ID, real-time monitoring flag, and quota settings. Subscribers are assigned default values for these properties.

Installing Protocol Packs

You install a protocol pack on an SCE platform using one of the following:

•The Cisco SCA BB Service Configuration Utility (see "The Cisco SCA BB Service Configuration Utility" section)

•The Network Navigator tool (see "How to Install a Protocol Pack" section)

Note If the protocol pack is an SPQI file you can enable and configure the hitless upgrade option using Hitless Upgrade CLI commands. (See "Hitless Upgrade of the SLI" section.)

The tool or utility performs the following steps:

1. Retrieves the current service configuration from the SCE platform and (optionally) stores a backup copy in a folder that you specify.

2. Imports the signatures that are in the DSS or SPQI file into the service configuration. This action overwrites any DSS that was previously imported into the service configuration.

3. For each new signature that includes a Buddy Protocol attribute (an attribute that points to an existing protocol) (see "The Buddy Protocol" section)—Adds the new signature to all services that include the buddy protocol.

4. If the protocol pack is an SPQI file—Replaces the SCE application. This action causes a short (up to one minute) downtime in SCE platform service.

5. Applies the new service configuration to the SCE platform.

If the protocol pack is an SPQI file and the hitless upgrade option is enabled, you can monitor the progress of the upgrade using the hitless upgrade CLI commands (see "Hitless Upgrade CLI Commands" section.)

Note Cisco SCE does not support direct downgrade of higher protocol pack versions to a lower protocol pack version. While downgrading the protocol pack from a higher version to a lower version, the Cisco SCA BB console displays an error message and prevents you from applying the policy on the Cisco SCE. To downgrade from a higher PP version to a lower PP version, see the "Downgrading Protocol Packs" section.

Installing the Service Hierarchy Tree

Opening a PQB using the Client (GUI) exposes its service hierarchy tree (signatures, flavors, protocols, and so on). The client defines the Service Configuration Hierarchy.

When loading a PQB file from the SCE, the PQB Hierarchy Tree must be of the same version as the one in the client. In other words, the PQB must be the same version as the Client, otherwise the PQB does not open.

Because the client can be connected with different SCE with different versions, and each PQB can have different Service Hierarchy Tree definition, you must install the relevant Service Hierarchy Tree in the Client (GUI) before opening a PQB.

The client can install the service hierarchy tree according to the SCE version. The GUI installation comes with a fixed set of service hierarchy elements which are placed in a specific version-related jar file. You can select between different jar files related to different versions.

Note The SCE service hierarchy tree is different than the client version. When installing a service hierarchy tree for a SCE:

•Always back up user PQB before upgrade to PPXY and keep a copy since the PQB is changed.

•Remove/Reinstall Service Tree Protocol.

To view, install, and remove the service hierarchy tree use the following procedures:

•View and Install Service Hierarchy Tree

•Remove Service Hierarchy Tree

View and Install Service Hierarchy Tree

Step 1 To view the service hierarchy tree, open the Protocol Pack tab.

Step 2 From the toolbar, select Service Configuration Editor (see Figure 4-12).

Figure 4-12 Service Configuration Editor - Preferences

Step 3 Select Preferences and then select Service Configuration.

A Preferences window opens (see Figure 4-13).

Figure 4-13 Service Configuration Editor - Service Configuration

Step 4 Select Protocol Pack from the Service Configuration tree (see Figure 4-14). The upper window provides information related to service hierarchy tree related to the GUI.

Figure 4-14 Preferences (Filtered)

Step 5 To install a new service hierarchy tree, click the Choose File button and select either a jar file or an SPQI file (see Figure 4-15).

Figure 4-15 Select Protocol Pack

Step 6 Click Open, and approve the warning message (see Figure 4-16) by clicking OK.

Figure 4-16 Protocol Pack Selection Warning Message

Step 7 To back up the current protocol pack and install the new service hierarchy tree, approve the backup message (see Figure 4-17) by clicking OK.

Figure 4-17 Protocol Pack Selection Backup Message

Remove Service Hierarchy Tree

To remove the service hierarchy tree and to return to the default configuration, perform these steps:

Step 1 Click the Clear Default Protocol Pack button in the Preferences window (see Figure 4-18).

Figure 4-18 Preferences (Filtered)

Step 2 Accept the operation by clicking OK on the Protocol Pack Removal message screen (see Figure 4-19).

Figure 4-19 Protocol Pack Removal Message

The service hierarchy tree is removed from the system, and when a new PQB is opened, install the default service classifications.

How to Verify Version Compatibility for Protocol Packs

A protocol pack is compatible only with specific versions of the SCE application. When working with protocol packs, verify that the protocol pack version matches the SCE application version. For example, only use a protocol pack for 4.0.0 on SCE application version 4.0.0.

The version compatibility information for each protocol pack is included in the release notes of the protocol pack.

Step 1 Verify that the correct version of servconf is installed and running correctly.

•From the command prompt, type servconf --version.

•Press Enter.

The version of the utility should match that of the protocol pack.

Step 2 Verify that the correct version of the SCE application is installed.

•At the SCE platform CLI prompt (SCE#), type show version.

•Press Enter.

The application version should match that of the protocol pack.

Step 3 Verify that a service configuration (PQB) is applied to the SCE platform.

•In the Console, retrieve and view the current PQB.

How to Verify the Installation of a Protocol Pack

Step 1 At the SCE platform CLI prompt (SCE#), type show version.

Step 2 Press Enter.

The response shows the version of the OS running on the SCE platform. This response includes information about the installed protocol pack version.

Step 3 Retrieve the PQB from the SCE platform and view it using the Console.

Step 4 Verify that the new protocols from the protocol pack were added to the service configuration.

The problems that may cause the installation of a protocol pack to fail and their remedies include:

•Missing or incorrect version of the JRE—Install the correct version of the JRE (see "Installing the Java Runtime Environment" section).

•Incorrect or missing SCE application version on the SCE platform—Verify that the correct version of the SCE application is installed (see "How to Verify Version Compatibility for Protocol Packs" section).

•No service configuration (PQB) is applied to the SCE platform—Create a new PQB and apply it using the Console.

•servconf failed to import the new signatures into the PQB—Use the --force-signature update signature option when running servconf (see "servconf Syntax" section).

When reporting problems to Cisco, please include the servconf log file, located at <user.home>\.p-cube\servconf.log. With Windows, this usually maps to C:\Documents and Settings\<username>\.p-cube\servconf.log or C:\Users\<username>\.p-cube\servconf.log.

Downgrading Protocol Packs

To downgrade from a higher protocol pack version to a lower protocol pack version, perform these steps:

Note When you apply a PQB file on a Cisco SCE using the Cisco SCA BB console, ensure that the version of the PQB file created is less than or equal to the Cisco SCOS and the protocol pack versions installed on the Cisco SCE.

Step 1 Click the Clear Default Protocol Pack button in the Preferences window (see Figure 4-20).

Figure 4-20 Preferences (Filtered)

Step 2 Accept the operation by clicking OK on the Protocol Pack Removal message screen (see Figure 4-21).

Figure 4-21 Protocol Pack Removal Message

Step 3 Close and reopen the Cisco Service Control Application for Broadband and apply the default service classifications.

Hitless Upgrade of the SLI

Hitless upgrade is the Cisco SCA BB method of upgrading the software components that reside on the SCE platform without incurring any service downtime.

•Hitless upgrade of Protocol Packs is available on SCE 8000.

•Hitless upgrade is available on SCE 2000 and SCE 1000_2U platforms.

•Hitless upgrade is not available on SCE 1000_1.5U platforms.

Note To know whether the Cisco SCE 2000 supports hitless upgrade for a particular PP release, see the Cisco Service Control Application for Broadband Protocol Pack Notes.

If hitless upgrade is enabled, classification, reporting, and control continue uninterrupted when you install an SPQI file (see "Working with Protocol Packs" section). You can install SPQI files using either the Console or servconf, the Cisco SCA BB Service Configuration Utility. An SPQI file is a package that includes the required (SLI) files.

Note When you apply a new policy or during Protocol Pack upgrade, there is a delay of 30 seconds before the rules are applied to the new flows.

After the new application is loaded on the SCE platform:

•The new application services all new flows and bundles.

•The old application continues to service existing flows (and new flows that belong to bundles of existing flows).

•Both applications share available memory.

Until all old flows die or are killed, the hitless upgrade is considered to be in progress. To make the hitless upgrade process bounded, you can set criteria that triggers the explicit killing of all flows still executing on the old application. Two such criteria exist:

•When a specified amount of time has passed since the process started.

•When the number of old flows goes below a specified threshold.

The default value for the first criterion is 60 (minutes); the default value for the second is zero (flows). This means that the replace operation is guaranteed to complete after no more than one hour (sooner, if all old flows die naturally). But the application does not kill any old flow before one hour completes.

These criteria are configurable by CLI commands.

You can initiate the explicit killing of all old flows using a manual command.

Hitless Upgrade CLI Commands

You can configure, monitor, and control hitless upgrade using the SCE platform Command-Line Interface (CLI). For more information about the SCE platform CLI, see the Cisco SCE 8000 CLI Command Reference.

The commands listed here are explained in the following section.

Use the following CLI commands to configure the criteria for completing a hitless upgrade:

replace completion time <minutes>

no replace completion time

default replace completion time

replace completion num-flows <num>

no replace completion num-flows

default replace completion num-flows

These commands are line interface configuration commands. To run these commands you must enter line interface configuration mode and see the SCE(config if)# prompt displayed. For details on interface configuration mode, see "How to Enter Line Interface Configuration Mode" section.

The following two CLI commands are EXEC mode commands.

Use the following CLI command to monitor the progress of a hitless upgrade:

show applications slot <num> replace

Use the following CLI command to force immediate completion of a hitless upgrade:

application slot <num> replace force completion

Description of Hitless Upgrade CLI Commands

Table 4-1 describes the hitless upgrade CLI commands listed in the previous section.

How to Enter Line Interface Configuration Mode

To run line interface configuration commands, enter the line interface configuration mode and see the SCE(config if)# prompt displayed.

Step 1 At the SCE platform CLI prompt (SCE#, type configure.

Step 2 Press Enter.

The SCE(config)# prompt appears.

Step 3 Type interface LineCard 0.

Step 4 Press Enter.

The SCE(config if)# prompt appears.

How to Launch the Console

Step 1 Choose Start > All Programs > Cisco SCA > SCA BB Console 4.1.x > SCA BB Console 4.1.x.

The Cisco SCA BB Console splash screen appears.

After the Console has loaded, the main window of the Console appears.

The first time that you launch the Console, the Welcome view is open in the main window (see Figure 4-22).

Figure 4-22 Welcome - Introducing Cisco Service Control

Step 2 Close the Welcome view and click Go to the console.

The Welcome view closes. The Network Navigator tool is open in the Console (see Figure 4-23).

Figure 4-23 Network Navigator

Note When you close the Console, it remembers which tools are open, which is the active tool, and whether the Welcome view is displayed. The Console then applies this view the next time you launch the Console.

How to Use the Console

The Console is the front end of Cisco SCA BB. You use it to configure the services that the SP offers to you.

The Console consists of the following tools:

•Network Navigator tool

•Service Configuration Editor tool

•Signature Editor tool

•Subscriber Manager GUI tool

•Anonymous Groups Manager GUI tool

The Console GUI has a menu bar and a standard toolbar (see Figure 4-24). Underneath the toolbar is another bar that displays the button of any open Console tool. When you launch a tool, a button is added to this bar. To switch between open tools, click the appropriate button on the bar.

Figure 4-24 Menu Bar and Toolbar of the Console GUI

Note The title of the Console window shows the active tool and the active service configuration.

The Welcome View of the Console links to a number of Configuration Wizards that can configure the initial, basic configuration of your system:

•Configuration Wizards

•The Network Navigator Tool

•The Service Configuration Editor Tool

•The Signature Editor Tool

•The Subscriber Manager GUI Tool

•The Anonymous Group Manager Tool

•Online Help

Configuration Wizards

The configuration wizards available from the Welcome view are (three of these wizards can also be executed from the Network Navigator tool):

•Usage Analysis wizard—Creates a simple model of devices and connects to them.

•The P2P Traffic Optimization wizards:

–P2P Traffic Optimization wizard—Creates a simple model of devices, connects to them, and limits P2P traffic to a specified percentage of total available bandwidth.

–P2P Traffic Optimization at a Peering Point wizard—Creates a simple model of devices, connects to them, limits P2P traffic to a specified percentage of total available bandwidth, and allows you to enable asymmetric routing classification mode.

Asymmetric Routing

Traffic processing depends on the routing environment. The Cisco Service Control solution can operate in two typical routing schemes: symmetric and asymmetric. In asymmetric routing, for a significant number of flows, only one direction (inbound or outbound) is routed through the SCE platform.

Anonymous Subscriber Mode

Anonymous subscriber mode is a mode in which entities defined as IP addresses are treated as subscribers.

How to Use the Usage Analysis Wizard

The Usage Analysis wizard allows you to create a simple model of devices and connect to them.

Note If they do not exist, devices defined in the wizard are added to the default site in the Site Manager tree.

Step 1 From the Console main menu, choose Help > Welcome.

The Welcome view opens (see Figure 4-25).

Figure 4-25 Welcome - Introducing Cisco Service Control

Step 2 Click Usage Analysis Wizard.

The Welcome page of the Usage Analysis wizard appears (see Figure 4-26).

Figure 4-26 Usage Analysis

Note You can also execute the Usage Analysis wizard from the Network Navigator tool:

1. Select one or more devices in the Site Manager tree.

2. Right-click one of the selected devices.

3. From the popup menu that appears, select Configuration Wizards > Usage Analysis Configuration.

4. You can set only one CM database in the wizard. If you select more than one CM database, only one CM database is selected and a warning message is displayed. Click OK to continue.

Step 3 Click Next.

The SCE IP Addresses page of the Usage Analysis wizard opens (see Figure 4-27).

Figure 4-27 SCE IP Addresses

Step 4 In the edit box, enter the IP addresses of the SCE devices that should be added to the model.

If you started from the Network Navigator, the IP addresses of the SCE devices that you selected are displayed in the edit box. You can add additional addresses.

Note You can work with up to 20 SCE devices at one time using the wizard.

Step 5 Click Next.

The SCE Usernames and Passwords page of the Usage Analysis wizard opens (see Figure 4-28).

Figure 4-28 SCE Usernames and Passwords

Step 6 Enter the usernames and passwords for the SCE devices.

Do one of the following:

•To use the same username and password for all the SCE devices that you are adding, enter the username in the Username field and the password in the Password field.

•To provide a different username and password pair for each SCE device, select the Use separate usernames and passwords for each SCE platform radio button, and, for each SCE device, enter the username and password in the appropriate cell of the table.

Step 7 Click Next.

The CM Setup page of the Usage Analysis wizard opens (see Figure 4-29).

Figure 4-29 CM Setup

Step 8 Define the SCSM Collection Manager (CM) to use with this configuration.

Do one of the following:

•Enter the IP address, username, and password of the CM device in the appropriate fields.

If you started from the Network Navigator, this information is retrieved and displayed. You can modify these parameters.

•Check the Skip this step check box.

Step 9 Click Next.

The Connectivity Test page of the Usage Analysis wizard opens (see Figure 4-30).

Figure 4-30 Connectivity Test

The wizard tests to see that the connections to the defined devices can be made.

Note If a connection to one or more of the devices cannot be made or if there is some problem with the connection (such as invalid version of the device) an error is displayed next to the device. You can skip these tests by clicking Skip connectivity test. The connections are validated when you click Finish at the end of the wizard.

Step 10 Click Next.

The Anonymous Subscribers page of the Usage Analysis wizard opens (see Figure 4-31).

Figure 4-31 Anonymous Subscribers

Step 11 To disable anonymous subscriber mode, clear the Enable Anonymous Subscribers mode check box.

Step 12 Click Next.

The Confirmation page of the Usage Analysis wizard opens (see Figure 4-32).

Figure 4-32 Confirmation

The actions that the wizard is about to take are listed on the page.

Step 13 Click Finish.

The Configuration Output page of the Usage Analysis wizard opens (see Figure 4-33).

Figure 4-33 Configuration Output

New devices are added to the default site of the Site Manager tree in the Network Navigator (see Figure 4-34).

Figure 4-34 Site Manager Tree

The wizard attempts to connect to all devices that you defined. The operation fails if:

•The wizard cannot connect to any of the SCE devices that you listed in Step 4.

•You defined a CM in Step 8, but the wizard cannot connect to it.

If you defined a CM in Step 8, the SCE devices are configured so that the only category 1 RDR destination is the CM.

Note RDR categories are the mechanism by which different types of RDRs can be sent to different collectors. For more information about RDR categories, see either the "Raw Data Formatting: The RDR Formatter and NetFlow Exporting" chapter of Cisco SCE8000 10GBE Software Configuration Guide or the "Raw Data Formatting: The RDR Formatter and NetFlow Exporting" chapter of Cisco SCE8000 GBE Software Configuration Guide.

A new service configuration named Usage Analysis is created, and opens in the Service Configuration Editor (see Figure 4-35).

Figure 4-35 Service Configuration Editor

The service configuration has the following characteristics:

•Report Only mode.

•The maximum Transaction RDR rate is set as the default value (250) divided by the number of SCE devices. To configure the Transaction RDR see "How to Manage Transaction RDRs" section. The content and structure is listed in "Transaction RDR" section in the "Raw Data Records: Formats and Field Contents" chapter of Cisco Service Control Application for Broadband Reference Guide.

The service configuration is applied to the SCE devices.

Step 14 Click Close.

The Usage Analysis wizard closes.

How to Use the P2P Traffic Optimization Wizards

There are two wizards for optimizing P2P traffic:

•The P2P Traffic Optimization wizard allows you to create a simple model of devices, connect to them, and limit P2P traffic to a specified percentage of total available bandwidth.

•The P2P Traffic Optimization at a Peering Point wizard allows you to create a simple model of devices, connect to them, limit P2P traffic to a specified percentage of total available bandwidth, and enable asymmetric routing classification mode.

Note If they do not exist, devices defined in the wizard are added to the default site in the Site Manager tree.

Step 1 From the Console main menu, choose Help > Welcome.

The Welcome view opens (see Figure 4-36).

Figure 4-36 Welcome - Introducing Cisco Service Control

Step 2 Click P2P Traffic Optimization Wizard or P2P Traffic Optimization for Asymmetrical Routing Wizard.

The Welcome page of the selected wizard appears (see Figure 4-37 or Figure 4-38).

Figure 4-37 P2P Traffic Optimization

Figure 4-38 P2P Traffic Optimization for Asymmetrical Routing

Note You can also execute the P2P Traffic Optimization wizard from the Network Navigator tool.

1. Select one or more devices in the Site Manager tree.

2. Right-click one of the selected devices.

3. From the popup menu that appears, choose Configuration Wizards > P2P Traffic Optimization Wizard or Configuration Wizards > P2P Traffic Optimization for Asymmetrical Routing Wizard.

Note You can set only one CM database in the wizard. If you select more than one CM database, only one CM database is selected and a warning message is displayed. Click OK to continue.

Step 3 Click Next.

The SCE IP Addresses page of the P2P Traffic Optimization wizard opens (see Figure 4-39).

Figure 4-39 SCE IP Addresses

Step 4 In the edit box, enter the IP addresses of the SCE devices that should be added to the model.

If you started from the Network Navigator, the IP addresses of the SCE devices that you selected are displayed in the edit box. You can add additional addresses.

Note You can work with up to 20 SCE devices at one time using the wizard.

Step 5 Click Next.

The SCE Usernames and Passwords page of the P2P Traffic Optimization wizard opens (see Figure 4-40).

Figure 4-40 SCE Usernames and Passwords

Step 6 Enter the usernames and passwords for the SCE devices.

Do one of the following:

•To use the same username and password for all the SCE devices that you are adding, enter the username in the Username field and the password in the Password field.

•To provide a different username and password pair for each SCE device, click the Use separate usernames and passwords for each SCE platform radio button, and, for each SCE device, enter the username and password in the appropriate cell of the SCE device table.

Step 7 Click Next.

The CM Setup page of the P2P Traffic Optimization wizard opens (see Figure 4-41).

Figure 4-41 CM Setup

Step 8 Define the Cisco Service Control Collection Manager (CM) to use with this configuration.

Do one of the following:

•Enter the IP address, username, and password of the CM device in the appropriate fields.

If you started from the Network Navigator, this information is retrieved and displayed. You can modify these parameters.

•Check the Skip this step check box.

Step 9 Click Next.

The Connectivity Test page of the P2P Traffic Optimization wizard opens (see Figure 4-42).

Figure 4-42 Connectivity Test

The wizard tests to see that the connections to the defined devices can be made.

Note If a connection to one or more of the devices cannot be made or if there is some problem with the connection (such as invalid version of the device), an error is displayed next to the device. You can skip these tests by clicking Skip connectivity test. The connections are validated when you click Finish at the end of the wizard.

Step 10 Click Next.

The Anonymous Subscribers page of the P2P Traffic Optimization wizard opens (see Figure 4-43).

Figure 4-43 Anonymous Subscribers

Step 11 To disable anonymous subscriber mode, uncheck the Enable Anonymous Subscribers mode check box.

Step 12 Click Next.

The effect of P2P traffic optimization page of the P2P Traffic Optimization wizard opens (see Figure 4-44).

Figure 4-44 Effect of P2P Traffic Optimization

This page explains why you should optimize (limit) P2P traffic.

Step 13 Click Next.

The Link Rate Limits for P2P Traffic Optimization page of the P2P Traffic Optimization wizard opens (see Figure 4-45).

Figure 4-45 Link Rate Limits

Step 14 Use the sliders to configure the upstream and downstream link rate limits.

The scale of each slider is the percentage of the aggregated bandwidth of both links.

Step 15 If you are running the P2P Traffic Optimization wizard, go to Step 20.

If you are running the P2P Traffic Optimization for Asymmetrical Routing wizard, continue at the next step.

Step 16 Click Next.

The Classification of split flows page of the P2P Traffic Optimization wizard opens (see Figure 4-46).

Figure 4-46 Classification of Split Flows

Step 17 To enable asymmetric routing classification mode, check the Enable Asymmetric Routing Classification Mode check box.

Step 18 Click Next.

The Confirmation page of the P2P Traffic Optimization wizard opens (see Figure 4-47).

Figure 4-47 Confirmation

The actions that the wizard is about to take are listed on the page.

For an explanation of the bandwidth controller parameters, see "Subscriber BWC Parameters" section.

Step 19 Click Finish.

The Configuration Output page of the P2P Traffic Optimization wizard opens (see Figure 4-48).

Figure 4-48 Configuration Output

New devices are added to the default site of the Site Manager tree in the Network Navigator (see Figure 4-49).

Figure 4-49 Network Navigator

The wizard attempts to connect to all devices that you defined. The operation fails if:

•The wizard cannot connect to any of the SCE devices that you listed in Step 4.

•You defined a CM in Step 8, but the wizard cannot connect to it.

•You defined a database in Step 10, but the wizard cannot connect to it.

If you defined a CM in Step 8, the SCE devices are configured so that the only category 1 RDR destination is the CM.

Note RDR categories are the mechanism by which different types of RDRs can be sent to different collectors. For more information about RDR categories, see "Raw Data Records: Formats and Field Contents" chapter of Cisco Service Control Application for Broadband Reference Guide.

A new service configuration named P2P Traffic Optimization (or P2P Traffic Optimization for Asymmetrical Routing) is created, and opens in the Service Configuration Editor (see Figure 4-50).

Figure 4-50 Service Configuration Editor

The service configuration has the following characteristics:

•Full functionality mode.

•The upstream and downstream default AGCs are set with the link limit values defined in Step 16.

•For both the default package and the Unknown Subscriber Traffic package, the following upstream and downstream BWCs are created (Table 4-2):

The service configuration is applied to the SCE devices, the first SCE platform entered in Step 4 is selected as the source of service configuration data, and the Next button is enabled.

Step 20 Click Finish.

The P2P Traffic Optimization wizard closes.

The Network Navigator Tool

The Network Navigator is a tool that allows you to create and manage a simple model of all local and remote devices that are part of the Cisco Service Control solution.

For more information about the Network Navigator, see "Using the Network Navigator" section.

How to Open the Network Navigator Tool

Step 1 From the Console main menu, choose Tools > Network Navigator.

The Network Navigator tool opens (see Figure 4-51).

Figure 4-51 Network Navigator

How to Close the Network Navigator Tool

Step 1 Right-click the Network Navigator button.

Step 2 From the popup menu that appears, select Close.

The Network Navigator tool closes.

The Service Configuration Editor Tool

The Service Configuration Editor is a tool that allows you to create service configurations. A service configuration is a data structure that defines how the SCE platform analyses network traffic, what rules apply to the traffic, and what actions the SCE platform takes to enforce these rules.

Most of this document discusses using the Service Configuration Editor. See "Using the Service Configuration Editor" section.

•How to Open the Service Configuration Editor Tool

•How to Close the Service Configuration Editor Tool

How to Open the Service Configuration Editor Tool

Step 1 From the Console main menu, choose Tools > Service Configuration Editor.

A No Service Configuration Is Open dialog box appears (see Figure 4-52).

Figure 4-52 No Service Configuration Is Open

Step 2 Click Yes.

A New Service Configuration Settings dialog box appears (see Figure 4-53).

Figure 4-53 New Service Configuration Settings

Step 3 Select one of the System Operational Mode radio buttons.

•Transparent—The system does not generate RDRs and does not enforce active rules on the network traffic.

•Report only—The system generates RDRs only. No active rule enforcement is performed on the network traffic.

•Full functionality—The system enforces active rules on the network traffic and performs reporting functions (that is, generates RDRs).

Note You can change the system operational mode at any time.

Step 4 (Optional, but highly recommended if your system has a high proportion of unidirectional flows) To switch to asymmetric routing classification mode, check the Enable the Asymmetric Routing Classification Mode check box.

Note It is recommended that you do not change the routing classification mode after creating a service configuration, as this causes loss of service configuration data. (See "Asymmetric Routing Classification Mode" section.)

Step 5 Click OK.

A default service configuration opens in the Service Configuration Editor tool (see Figure 4-54).

Figure 4-54 Service Configuration Editor

How to Close the Service Configuration Editor Tool

Step 1 Right-click the Service Configuration Editor button.

Step 2 From the popup menu that appears, select Close.

The Service Configuration Editor tool closes.

The Signature Editor Tool

The Signature Editor is a tool that allows you to create and modify files that can add and modify protocols and protocol signatures in Cisco SCA BB.

For more information about the Signature Editor, see "Using the Signature Editor" section.

•How to Open the Signature Editor Tool

•How to Close the Signature Editor Tool

How to Open the Signature Editor Tool

Step 1 From the Console main menu, choose Tools > Signature Editor.

The Signature Editor tool opens (see Figure 4-55).

Figure 4-55 Signature Editor Tool

How to Close the Signature Editor Tool

Step 1 Right-click the Signature Editor button.

Step 2 From the popup menu that appears, select Close.

The Signature Editor tool closes.

The Subscriber Manager GUI Tool

The Subscriber Manager GUI is a tool that allows you to connect to a Cisco Service Control Subscriber Manager and then manage subscribers, assign packages to subscribers, edit subscriber parameters, and manually add subscribers.

For more information about connecting to a Cisco Service Control Subscriber Manager and using the Subscriber Manager GUI, see "Using the Subscriber Manager GUI Tool" section.

For more information about the Cisco Service Control Subscriber Manager, see the Cisco Service Control Management Suite Subscriber Manager User Guide.

This section contains information about the following procedures:

•How to Open the Subscriber Manager GUI Tool

•How to Close the Subscriber Manager GUI Tool

How to Open the Subscriber Manager GUI Tool

Step 1 From the Console main menu, choose Tools > Subscriber Manager.

The Subscriber Manager GUI tool opens (see Figure 4-56).

Figure 4-56 Subscriber Manager

How to Close the Subscriber Manager GUI Tool

Step 1 Right-click the Subscriber Manager button.

Step 2 From the popup menu that appears, select Close.

The Subscriber Manager GUI tool closes.

The Anonymous Group Manager Tool

The Anonymous Group Manager GUI allows you to manage anonymous groups within a SCE. You can create, edit, delete anonymous groups, and list all configured groups for a selected SCE. For a selected group, the GUI lists all anonymous subscribers that are part of the group.

For more information, see "Using the Anonymous Group Manager Tool" section.

For more information about the Cisco Service Control Subscriber Manager, see the Cisco Service Control Management Suite Subscriber Manager User Guide.

•How to Open the Anonymous Group Manager Tool

•How to Close the Anonymous Group Manager Tool

How to Open the Anonymous Group Manager Tool

Step 1 From the Console main menu, choose Tools > Anonymous Group Manager.

The Anonymous Group Manager tool opens (see Figure 4-57).

Figure 4-57 Anonymous Group Manager

How to Close the Anonymous Group Manager Tool

Step 1 Right-click the Anonymous Group Manager button.

Step 2 From the popup menu that appears, select Close.

The Anonymous Group Manager tool closes.

Online Help

You can access relevant parts of this user guide from the Console. The following sections provide you with the necessary details:

•How to Access Online Help

•How to Search Online Help

How to Access Online Help

Step 1 From the Console main menu, choose Help > Help Contents.

Online help opens in a separate window.

How to Search Online Help

You can also search online help from the current tool.

Step 1 From the Console main menu, choose Help > Search.

The Help view opens next to the current tool (see Figure 4-58).

Figure 4-58 Help

Step 2 Enter a word, phrase, or more complex search expression in the Search expression field.

The Go button is enabled.

Note Click >> (Expand) for an explanation of how to construct search expressions.

Step 3 Click Go.

Help topics containing your search expression are listed under Local Help.

Step 4 Click a help topic to view its contents.

Note You can bookmark topics for later reference.

Step 5 By clicking the appropriate link at the bottom of the Help view, you can switch to:

•All topics

•Related topics

•Bookmarks

QuickStart with the Console

This QuickStart section helps you get started with the Console. The section includes an example of using the Network Navigator tool and the Service Configuration Editor to apply the default service configuration to an SCE platform.

Example: How to Configure the Console and Apply the Default Service Configuration

In this example, you add an SCE device to the default site and apply the default service configuration to the SCE.

Step 1 Launch the Console.

Choose Start > All Programs > Cisco SCA > SCA BB Console 4.1.x > SCA BB Console 4.1.x.

(Here x stands for the version within 4. For example, 4.0.0)

Step 2 If necessary, close the Welcome view.

Step 3 Open the Network Navigator.

From the Console main menu, choose Tools > Network Navigator.

This step sets up the Console for network device operations.

Note The Network Navigator tool is open the first time you launch the Console.

You should now be able to see the default site displayed in the Network Navigator view.

Step 4 Add an SCE device to the default site.

a. Right-click the default site, and, from the popup menu that appears, select New > SCE.

The Create new SCE wizard appears.

In the Address field, enter the actual IP address of an SCE platform.

b. Click Finish.

The Create new SCE wizard closes.

The new device is added to the site.

Step 5 Check the SCE platform version and operational state.

a. Right-click the SCE device and, from the popup menu that appears, select Online Status.

A Password Management dialog box appears.

b. Enter the username and password for managing the SCE.

c. Enter the SNMP RO Community String.

d. Click Extract.

The SCE online status is retrieved.

e. Check that the system and application versions are correct, and that the operational state is Active.

Step 6 Open the Service Configuration Editor.

•From the Console main menu, choose Tools > Service Configuration Editor.

The Service Configuration Editor opens.

A No Service Configuration Is Open dialog box appears.

Step 7 Create a new service configuration.

a. Click Yes in the No Editor Is Open dialog box.

A New Service Configuration Settings dialog box appears.

b. Click OK.

A default service configuration opens in the Service Configuration Editor tool.

Step 8 Apply the service configuration to the SCE platform.

a. From the toolbar, select the Apply Service Configuration to SCE Devices () icon.

A Password Management dialog box appears.

b. Enter the username and password for managing the SCE and click Apply.

The service configuration is applied to the SCE platform.