Cisco Broadband Policy Manager Operations Guide, Release 1.5 · Broadband Policy Manager (BPM). It discusses the EAC applications and their position in the BPM architecture, BPM and

Cisco Broadband Policy Manager Operations GuideSoftware Release 1.5

Corporate HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706 USAhttp://www.cisco.comTel: 408 526-4000

800 553-NETS (6387)Fax: 408 526-4100

Customer Order Number: Text Part Number: OL-7765-01

http://www.cisco.com

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

CCSP, CCVP, the Cisco Square Bridge logo, Follow Me Browsing, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Access Registrar, Aironet, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, FormShare, GigaDrive, GigaStack, HomeLink, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, LightStream, Linksys, MeetingPlace, MGX, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, ProConnect, RateMUX, ScriptShare, SlideCast, SMARTnet, The Fastest Way to Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.

All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0601R)

Cisco Broadband Policy Manager Operations Guide © 1999-2004 Cisco Systems, Inc. All rights reserved.

Contents

Contents

Preface................................................................................................................ xiIntroduction................................................................................................................................xiScope..........................................................................................................................................xiAudience ....................................................................................................................................xiConventions ..............................................................................................................................xii

Text ....................................................................................................................................xiiIcons................................................................................................................................. xiiiChapter 1 - Introduction.....................................................................................................xvChapter 2 - Routine Tasks..................................................................................................xvChapter 3 - Non-GUI Interfaces ........................................................................................xvChapter 4 - Maintenance Tasks..........................................................................................xvChapter 5 - Troubleshooting Tasks ....................................................................................xvAppendix A - Glossary ......................................................................................................xv

1 Introduction.........................................................................................................1Overview.....................................................................................................................................1Network Components .................................................................................................................2

Architectural Overview .......................................................................................................2Topology Awareness Function (TAF)..................................................................................4

TAF Overview ..............................................................................................................4TAF Interface Requirements ........................................................................................4

Topology Store Function (TSF)...........................................................................................5TSF Overview ..............................................................................................................5TSF Interface Requirements.........................................................................................5

Path Computation Function (PCF) ......................................................................................5PCF Overview ..............................................................................................................6PCF Interface Requirements.........................................................................................6

Admission Control Function (ACF) ....................................................................................6

Version 1.5 Cisco Broadband Policy Manager Operations Guide iii

Contents

ACF Overview..............................................................................................................6ACF Interface Requirements........................................................................................6

Signaling Interface Function (SIF) ......................................................................................7SIF Overview................................................................................................................7SIF Interface requirements ...........................................................................................7

Session Awareness Function (SAF).....................................................................................7SAF Overview..............................................................................................................7SAF Interface requirements..........................................................................................7

Context Timer Function (CTF)............................................................................................7CTF Overview..............................................................................................................8CTF Interface requirements..........................................................................................8

Accounting Log Function (ALF).........................................................................................8ALF Overview..............................................................................................................8ALF Interface requirements .........................................................................................8

Statistics Function (SF)........................................................................................................8SF Overview.................................................................................................................8SF Interface requirements.............................................................................................9

Alarm Notification Function (ANF)....................................................................................9Pool Function (PF)...............................................................................................................9

Deployment Components .........................................................................................................10Relations to Functional Interfaces .....................................................................................10

Director.......................................................................................................................10Resource Controller.................................................................................................... 11Topology Database Server .........................................................................................12

Firewall Requirements ..............................................................................................................12What’s Next?.............................................................................................................................12

2 Routine Tasks ....................................................................................................13Overview...................................................................................................................................13Starting and Stopping the BPM Platform .................................................................................14

Procedure: Starting the Domain Controller BPM..............................................................14Procedure: Starting the Other Platforms............................................................................14Procedure: Stopping the Domain Controller BPM............................................................14Procedure: Stopping the Other Platforms ..........................................................................15

iv Cisco Broadband Policy Manager Operations Guide Version 1.5

Contents

BPS Installation Procedure .......................................................................................................16Procedure: Installing the BPS............................................................................................16

BPS Login.................................................................................................................................18Procedure: BPS - Logging in to the BPS System..............................................................19

BPDS Installation Procedure ....................................................................................................21Procedure: Installing the BPDS.........................................................................................21

BPDS Login ..............................................................................................................................23Procedure: BPDS - Logging in to the BPDS System ........................................................24

Observing Component Status ...................................................................................................26Network Administration Tree Pane ...................................................................................26

Service Engine Configuration ....................................................................................27Agent Configuration...................................................................................................28

Service Design Tree Pane ..................................................................................................28Procedure: Viewing Information about Policy Functions ..........................................28Procedure: Viewing Information about Rules ............................................................31

Statistics ....................................................................................................................................35Agent Statistics ..................................................................................................................35Other Statistics...................................................................................................................36

SNMP Traps..............................................................................................................................37Non-GUI Statistics....................................................................................................................38

TDS Statistics ....................................................................................................................38Director Statistics...............................................................................................................38Resource Controller Statistics............................................................................................39

Accounting................................................................................................................................39Director Accounting Log Messages ..................................................................................43Resource Controller Accounting Log Messages ...............................................................44

Error Messages .........................................................................................................................45Log Pane ............................................................................................................................45Log Messages ....................................................................................................................45

Log File Format..........................................................................................................46Severity Definitions....................................................................................................46Example Log Entry.....................................................................................................46

System Status ............................................................................................................................46Status Bar...........................................................................................................................47

Version 1.5 Cisco Broadband Policy Manager Operations Guide v

Contents

Role-Based Access Control (RBAC)........................................................................................48Elements of the BPM RBAC.............................................................................................48

Roles ...........................................................................................................................48Users ...........................................................................................................................48Resources....................................................................................................................48Actions........................................................................................................................48Permissions.................................................................................................................49

Using RBAC......................................................................................................................50Starting RBAC............................................................................................................50Roles ...........................................................................................................................52Users ...........................................................................................................................59Importing and Exporting RBAC Data........................................................................71

Backup and Restore ..................................................................................................................72What’s Next?.............................................................................................................................73

3 Non-GUI Interfaces ..........................................................................................75Overview...................................................................................................................................75Portal .........................................................................................................................................75

Portal Access .....................................................................................................................76Procedure: Searching for Links, Nodes, and Resources.............................................76

Portal Information..............................................................................................................77Procedure: Displaying Resource Information ............................................................77Procedure: Displaying Node Information ..................................................................80Procedure: Displaying Link Information....................................................................81

Portal Operations ...............................................................................................................82Accounting Functions ...............................................................................................................82Q-shell Command Line Utility .................................................................................................83

Invoking qssh..............................................................................................................83help .............................................................................................................................83StartSession ................................................................................................................83StopSession.................................................................................................................83ShowSessions .............................................................................................................83ShowResources...........................................................................................................84ShowNodes.................................................................................................................84

vi Cisco Broadband Policy Manager Operations Guide Version 1.5

Contents

ShowLinks..................................................................................................................84ShowStats ...................................................................................................................84ShowTimeouts ............................................................................................................84RemoveAllLinks.........................................................................................................84RemoveAllNodes .......................................................................................................84RemoveAllResources .................................................................................................84ClearTopology ............................................................................................................84Timeout.......................................................................................................................85qosConfigure ..............................................................................................................85qosGetConfiguration ..................................................................................................85qosStartServer.............................................................................................................85

Environment Variables.......................................................................................................85Statistics ....................................................................................................................................85What’s Next?.............................................................................................................................85

4 Maintenance Tasks............................................................................................87Overview...................................................................................................................................87Director Procedures ..................................................................................................................88

Adding a Director ..............................................................................................................88Removing a Director..........................................................................................................89

Resource Controller Procedures ...............................................................................................89Adding Resource Controller ..............................................................................................89Removing a Resource Controller.......................................................................................90Starting Resource Controller .............................................................................................90

Deploying Components ............................................................................................................91Procedure: Deploying an Agent.........................................................................................91Procedure: Undeploying an Agent.....................................................................................92Procedure: Deploying a Service ........................................................................................93Procedure: Undeploying a Service ....................................................................................95

Configuring Components..........................................................................................................97Procedure: Configuring a Standby Service Engine ...........................................................97Procedure: Changing the Name of a Component ..............................................................99Procedure: Changing Agent Configuration .....................................................................100

Agent Properties Dialog Box....................................................................................102

Version 1.5 Cisco Broadband Policy Manager Operations Guide vii

Contents

Agent Devices Dialog Box.......................................................................................103Procedure: Patching .........................................................................................................103

Clusters and Failover ..............................................................................................................104Procedure: Using Broadband Policy Studio to Create a Cluster .....................................104

Interface Hostname Files ..........................................................................................107Procedure: Verifying Cluster Health................................................................................109

Viable Cluster ...........................................................................................................109Failed Cluster............................................................................................................110

Procedure: Manually Initiating Failover.......................................................................... 111Procedure: Dissolving a Cluster ......................................................................................113Failover ............................................................................................................................113

Manual Failover........................................................................................................114Automatic Failover...................................................................................................114Resolving Failover....................................................................................................114

Failed Node Recovery .....................................................................................................117Recovering When Active Node Fails .......................................................................117Recovering When Standby Node Fails.....................................................................122

Recovering from a Hard Failure - Power Loss or Power Cable Disconnected ...............127Procedure: Recovering Policy Repositories .............................................................127Procedure: Recovering Session Controller BPMs....................................................132Procedure: Setting Up the Standby Domain Controller BPM..................................136

What’s Next?...........................................................................................................................138

5 Troubleshooting Tasks ....................................................................................139Overview.................................................................................................................................139Logging in...............................................................................................................................139System Information.................................................................................................................139

Network Administration Tree Pane .................................................................................139Service Engine Status ...............................................................................................140Agent Status..............................................................................................................141Service Status ...........................................................................................................142

Log Pane ..........................................................................................................................143Isolating the Problem ..............................................................................................................143Investigating Hardware Issues ................................................................................................144

viii Cisco Broadband Policy Manager Operations Guide Version 1.5

Contents

Investigating Software Issues .................................................................................................144Troubleshooting Considerations .............................................................................................145

Is the BPM Running? ......................................................................................................145Is the Service Engine Running?.......................................................................................145Are Services and Agents Deployed? ...............................................................................145When Did Problem Occur?..............................................................................................145

Appendix A - Glossary ...................................................................................147

Index..........................................................................................................................165

Version 1.5 Cisco Broadband Policy Manager Operations Guide ix

Preface

Preface

IntroductionThis guide presents information for the Broadband Policy Manager (BPM) and covers the following topics:• Operations• Maintenance• Troubleshooting

This guide contains procedures that the administrator can perform using the BPM. Some command line procedures are included where there are no BPM equivalents.

ScopeThis guide provides instructions for conducting routine tasks, ongoing maintenance tasks, and troubleshooting problems.

AudienceThis guide is for the network or service administrator who performs operations, maintenance, and troubleshooting tasks.

Version 1.5 Cisco Broadband Policy Manager Operations Guide xi

Preface

ConventionsThis guide may use the text and icon conventions described in this section.

TextThe table below contains documentation text conventions.

Table 1. Text Conventions

Convention Explanation Example

alternate mouse button

Usually indicates the right mouse button.

Click the agent with the alternate mouse button.

arrow -->

Indicates the selection order of menu items.

File --> SaveThis indicates go to the File menu and choose the Save function.

bar brackets [ ]

Indicate the default. Choose your Name Service type [2]:This indicates the default is 2.

bold Indicates user input or button selection.

poweron

bold italic Indicates objects, attributes, pin names, and service flows.

On the backend, monitor the policy database session table and verify that session was established and sessionstate is Accounting Started.

Ctrl+X Indicates the quick access key for a menu option.

Ctrl+M This indicates open the Object Manager.

default mouse button

Usually indicates the left mouse button.

Click the agent with the default mouse button.

italic Indicates an application, chapter, directory, document, header, section, or title names.

For more information, refer to the section entitled Creating Services.

<KEYNAME> Indicates press the named key. Supply the required information, then press the <ENTER> key.

screen display

Represents system output. This agent does not have any agent-specific properties.

xii Cisco Broadband Policy Manager Operations Guide Version 1.5

Preface

IconsThe following icon conventions provide additional information to indicate special conditions or possible risks:

Note: A note is an informational message containing a tip or suggestion.

Caution: A caution indicates a risk of damage to equipment or a loss of data.

Version 1.5 Cisco Broadband Policy Manager Operations Guide xiii

Preface

Documentation SetThe documentation for your BPM includes the following documents:• Cisco Broadband Policy Design Studio User Guide

This guide provides instructions for installing the BPS, and using the BPS to cre-ate, deploy, and manage network services.

• Cisco Broadband Policy Manager Operations GuideThis guide describes the use of the BPM to obtain information, conduct day-to-day operations, perform maintenance tasks, and troubleshoot problems with the BSM. This includes the Log Messages addendum, the Application Log Messages addendum, and the Statistics addendum.

• Cisco Broadband Policy Manager Installation and Configuration Guide

This guide describes how to install the software for the Broadband Policy Manager (BPM). It describes how to install and configure the Solaris operating system adapted for use by the BPM system. It also includes procedures to install and configure the BPM software and the procedures to install and log into the Broadband Policy Studio (BPS) graphical user interface (GUI).

• Cisco Bandwidth Manager Edge Admission Control This guide discusses the Edge Admission Control (EAC) offering that runs on the Broadband Policy Manager (BPM). It discusses the EAC applications and their position in the BPM architecture, BPM and EAC components, possible deploy-ment scenarios and supported platforms.

• Cisco Broadband Policy Manager Release NotesThis document describes new features, known limitations, and other important information about the BPM system.

xiv Cisco Broadband Policy Manager Operations Guide Version 1.5

Preface

OrganizationThis guide contains the following chapters:

Chapter 1 - IntroductionIntroduction to the operations guide.

Chapter 2 - Routine TasksProcedures for performing day-to-day operations tasks.

Chapter 3 - Non-GUI InterfacesProcedures for performing tasks without a GUI interface.

Chapter 4 - Maintenance TasksProcedures for performing necessary maintenance tasks.

Chapter 5 - Troubleshooting TasksSuggestions for dealing with problems.

Appendix A - GlossaryGlossary of BPM terms.

Version 1.5 Cisco Broadband Policy Manager Operations Guide xv

Introduction

1

Introduction

OverviewThe Broadband Policy Studio (BPS) is a graphical user interface to the Broadband Policy Manager (BPM). The BPS includes the following:• Network Administration screen, which shows BPM data from a network point of

view, including service engines, agents, and services

The Broadband Policy Design Studio (BPDS) is a similar graphical user interface to the BPS. It has the same Network Administration screens that the BPS has, and also includes:• Service Design screen, which shows the structure of existing services and allows

you to create new services.

You can use the BPDS or BPS to obtain BPM information, conduct routine operations, perform necessary maintenance tasks, and troubleshoot problems. In addition, for some tasks, there is a command line interface (CLI) that allows you to enter certain commands directly. To enter CLI commands, first ssh to the correct machine, log in as the correct user, then enter the commands at the command line.

Version 1.5 Cisco Broadband Policy Manager Operations Guide 1

Introduction

Network ComponentsArchitectural Overview

The delivery of Telephony CAC utilizes some generalized internal components, including:• Topology Awareness Function• Topology Store Function• Path Computation Function• Admission Control Function• Signaling Interface Function• Session Awareness Function• Context Timer Function• Accounting Log Function• Statistics Function• Alarm Notification Function• Pool Function

The functional components connect through well-defined interfaces to comprise the Directors and Resource Controllers.

2 Cisco Broadband Policy Manager Operations Guide Version 1.5

Introduction

Figure 1 illustrates a Director.

Figure 1. Director Architecture


Introduction

Figure 2 illustrates a Resource Controller.

Figure 2. Resource Controller Architecture

Topology Awareness Function (TAF)This section describes the topology awareness function (TAF).

TAF OverviewThe topology awareness function extracts and reacts to changes in the underlying network. The TAF extracts this information in a variety of ways, including reading it from provisioning files and receiving it from the Topology Database Server. The information is stored using the topology store function, which maintains the information model in a data store.

TAF Interface RequirementsThe topology awareness function has two discrete interface functions:• interface to the network, over which network discovery detail is extracted• interface to the topology store function, over which topology data is recorded

within the topology store information model


Introduction

Topology Store Function (TSF)This section describes the topology store function (TSF).

TSF OverviewThe topology store function maintains the topology information model (TIM) for a given component. Topology updates are received from the Topology Database Server, using the component's TAF. The TSF stores those updates in the TIM. The TIM is stored in a database as a group of nodes connected by links. The nodes represent physical or abstract network devices, and the links represent physical or abstract connectivity between them. Information (resources) may be attached to nodes to describe their capabilities (for example, QoS capabilities per interface, per sub-interface, and per session). Information (resources) may also be attached to links (for example, bandwidth capabilities, delay properties, and service function). The TSF supports the concept of distinct information realms, allowing the application to segment topology and resource representation for increased performance and stability. Each node has a unique identifier, which may depend on the deployment scenario. Each link is stored as a directed association between two nodes. Other elements using the TSF, such as the PCF or ACF, may use the TIM to determine the path between two end points, or update resources in the TIM. Depending on the deployment scenario, links and nodes do not necessarily describe the physical topology of the network. For cases where tunnels are used (such as MPLS), the relationship describes the tunnel head end and remote nodes, and chooses to ignore the actual core topology underlying this path. This virtualization allows the admission control criteria to dictate the requirements on the TIM.

TSF Interface RequirementsThe topology store function has three separate interfaces to the other system functional components (ACF, PCF and TAF). The same interface is utilized to support the requirements of this interconnectivity.

Path Computation Function (PCF)This section describes the path computation function (PCF).


Introduction

PCF OverviewThe path computation function determines the path through the topology for any given end-to-end session, as requested by the ACF. The PCF determines from a request which nodes and links are used for session interconnectivity. The result may return both symmetrical and asymmetrical paths for certain sections of the topology. The PCF accesses the TIM via the TSF, to provide its underlying representation of the network.

PCF Interface RequirementsThe Path Computation Function has two discrete interfaces (both of which are internal):• an interface to the admission control function (ACF), through which the ACF

requests path details on a given session request• an interface to the TIM via the TSF, through which the PCF can extract raw

topology data over which to determine path calculations. This interface is the same for ACF --> TSF or PCF --> TSF.

Admission Control Function (ACF)This section describes the admission control function (ACF).

ACF OverviewThe admission control function handles QoS requests from the SIF. Based on these requests, the ACF initiates appropriate measures to determine whether there is capability to satisfy the requirements of any given session request. The ACF can support extremely sophisticated policy decision rules. In cases where the network (and network devices) permit dynamic resizing of link bandwidth and queue capacity, the ACF can dynamically resize links to make a positive admission control decision.

ACF Interface RequirementsThe admission control function (ACF) has several (internal only) interfaces:• an interface over which call set-up requests are delivered• an interface to the PCF, to calculate a path through the topology• an interface to the TSF, to allow the capacity of links in the TIM to be updated

(where capacity is a resource attached to a link). This can utilize the same interface methods as the PCF --> TSF and TAF --> TSF interface function.

• an interface to the topology interaction function (TIF), to enable requests for dynamic resizing to be handled


Introduction

Signaling Interface Function (SIF)This section describes the signaling interface function (SIF).

SIF OverviewThe signaling interface function sends QoS requests from the requesting application to the Director's ACF. If there is more than one Director, an external load balancer picks a Director to receive any given request. The SIF also receives replies from Director ACFs, and forwards them to the application. The SIF gives the ACF all necessary session parameters, to allow the ACF to accept or deny a call request. The SIF needs to support a variety of signaling protocols at its northbound interface into the requesting application.

SIF Interface requirementsThe signaling interface function (SIF) has two discrete interfaces:• an interface to the requesting application• an interface into the admission control function, which provides an abstracted

messaging model to the ACF

Session Awareness Function (SAF)This section describes the session awareness function (SAF).

SAF OverviewThe session awareness function obtains dynamic session information. This information may involve individual subscriber sessions (IP), subscriber network sessions (such as PPP), or possibly higher level session concepts such as IP pools. Each of these concepts represents a separate SAF.

SAF Interface requirementsThe session awareness function (SAF) has two discrete interfaces:• an interface to the network over which session awareness can be gleaned (such as,

RADIUS, DHCP, or e4 ETSI/TISPAN protocol)• an interface to the session store function (SSF), to permit session state to be

stored within the session database

Context Timer Function (CTF)This section describes the context timer function (CTF).


Introduction

CTF OverviewThe context timer function accomplishes soft-state semantics for contexts and the resources they consume. It periodically releases expired contexts, and recoups their resources. It does this by interfacing with the ACF (so it can perform QosRelease capability) and with the TSF (to retrieve and remove contexts.)

CTF Interface requirementsThe CTF has two interfaces, as well as interacting with other components:• an interface to allow timeouts to be registered with the CTF, or initiate an

immediate timeout check.• an interface to handle or initiate a timeout interval.• the CTF interfaces with the ACF, to initiate a QosRelease action for expired

contexts. It must use a reserved application function identifier to differentiate itself from an external QosRelease.

• the CTF interfaces with the CSF, to retrieve contexts in order to validate their expiration and retrieve necessary inputs to QosRelease.

Accounting Log Function (ALF)This section describes the accounting log function (ALF).

ALF OverviewThe accounting log function records entrance parameters, internal decisions, and exit responses. The caller provides accounting-pertinent information and a correlation identifier, and the ALF stores the information in an appropriate manner.

ALF Interface requirementsThe ALF receives accounting information through its defined interface.

Statistics Function (SF)This section describes the statistics function (SF).

SF OverviewThe statistics function is used to record and query statistics of the system. It provides a location for various components to store statistics concerning their runtime state and for other clients to inspect those statistics.


Introduction

The set of statistics are:• <AF>.qos.<action>.count

• <AF>.qos.<action>.accept.count

• <AF>.qos.<action>.deny.count

• <AF>.qos.<action>.error.count

• <AF>.qos.<action>.replay.count

Where <AF> is the Application function ID (also, a reserved key for the sum total of statistics for all the application functions), and <action> is the request name (that is, reserve, modify, refresh, or release).Certain statistics, such as “release deny”, are not expected to ever be incremented, but the statistic name exists for completeness and forward functional ability.

SF Interface requirementsThe SF interacts with its clients over its defined interface.

Alarm Notification Function (ANF)The ANF alerts external systems of aberrant behavior in the BPM. This is accomplished by issuing SNMP traps. The ANF allows various components of the PCS to report unexpected conditions and behavior, as well as unexpected lifecycle changes in a controlled and consistent manner.

Pool Function (PF)The PF encapsulates logic to resolve an IP address to a particular IP pool within the application domain. It segments pool sets based on VPN, so that each VPN defines a particular realm of pool information. The PF allows IP pools to be added, updated, and removed from its internal data structure. It also allows individual IP addresses to be matched against those pools. This matching allows other elements, such as the ACF in the Director to resolve dynamic IP addresses to the pools that they derive from. Coupled with the knowledge of where the pool is located, this is used to determine the Resource Controller that is responsible for the realm containing the IP address.


Introduction

Deployment ComponentsThere are some very specific high level functional elements. These are the Director, Resource Controller, and Topology Database Server.The Director is the functional element responsible for determining which Resource Controller component is responsible for a particular QoS request, coordinating the decisions returned by the Resource Controller component, and formulating a unified response.The Resource Controller is the targeted element that is responsible for QoS requests for a particular part of the topology information model (for example, a particular access network or node).The Topology Database Server is responsible for holding the global topology information model, from which Resource Controller components retrieve (or are provisioned) relevant segments, and the Director retrieves (or is provisioned) address pool information and the Resource Controller component mappings.

Relations to Functional Interfaces

DirectorThis is one or more stateless installations that takes requests from the application function and routes them to appropriate Resource Controllers, to handle the specific incoming requests. Each Director system can determine which Resource Controller is appropriate to handle resource tracking for a given request (or given endpoint of a request) and route the request appropriately. Also the Directors detect failures at the Resource Controller level and perform failovers from primary of a pair to its secondary, as needed. The Director encapsulates a very specific type of ACF, one that uses address pool information to determine the responsible Resource Controller components, augments the request with local context (which segment of the path the Resource Controller is responsible for), and forwards to the Resource Controller components. The Director ACF also collects the responses and aggregates the results into a unified response for the SIF. In the case of differing responses from Resource Controllers (for example, one Resource Controller accepts one side of a call, but another rejects it), the ACF is responsible for restoring appropriate state to the Resource Controller components.Thus, the Director represents:• SIF to interface with the external application function (AF)• ACF to perform a unified admission control decision (ACD)


Introduction

• TSF to store the Director TIM, which holds pool and Resource Controller entries for each aggregating access node (BRAS), as well as a node role resource to distinguish BRAS nodes from CPEs and MGWs

• TAF to react to external updates to the TIM, and to filter them into the internal TSF

• PF to determine the BRAS node that is associated with a particular IP address, via IP pool matching

• RCF for handling retransmission of messages• ALF for recording accounting information• SF for recording statistics• ANF for reporting alarms

Resource ControllerThe Resource Controller encapsulates an ACF that is responsible for performing the access network-level admission control decision (ACD) based on resource utilization.Thus, the Resource Controller represents:• SIF to interface with the external application function, which is the Director in

this case (because this is internal, the SIF is transparent)• TSF to maintain the TIM that the Resource Controller is responsible for and that

resource consumption is checked against, as well as session and context information

• TAF to interact with the TSF, to react to topology changes (link or node activation or deactivation) by correctly cleaning up internal state and resource utilization

• SAF to interact with the TSF and react to session changes by correctly cleaning up internal state and resource utilization

• PCF to determine the path through the local topology that the context (call) transits

• CTF to enact the soft-state reservation model, to automatically remove orphaned or otherwise stale contexts and the resources they consume

• ACF to perform local ACD, based on TIM resource utilization• RCF for handling retransmission of messages• ALF for recording accounting information• SF for recording statistics• ANF for reporting alarms


Introduction

Topology Database Server The Topology Database Server maintains the global topology information model. It provides a centralized configuration location, and the functionality for distributing the information to appropriate clients. The Topology Database Server is responsible for pushing information about IP address pools and Resource Controller to BRAS mappings to all Directors in the Director role. Also, it holds the ownership indication for each segment of the network (that is, which Resource Controller component is responsible for a particular set of links and nodes).The topology database also holds the responsibility of enacting repartitioning, which involves coordinating all other elements and migrating responsibility from one Resource Controller component to another for a piece of the network.Thus, the topology database represents:• TAF to interact with the TAF of Directors in the Director, as well as to push

topology to Resource Controller components• TSF to enact the local storage of the global TIM• ALF for recording accounting information• SF for recording statistics

Firewall RequirementsTo effectively communicate between nodes, any firewalls that are configured between the nodes must allow for all ports to be open. To do this, add a rule to each firewall that allows any port from the source node to the destination node, and vice versa.

What’s Next?Once you finish this section, you can continue with Chapter 2, Routine Tasks, which discusses day-to-day operations.


Routine Tasks

2

Routine Tasks

OverviewOperations tasks include day-to-day running of the Broadband Policy Manager (BPM). This may include examining information and monitoring components, such as service engines, agents, or services. You can perform many operations tasks using the BPM Broadband Policy Studio (BPS). The BPS gives a visual picture of the current BPM configuration. The BPS uses standard windowing techniques and editing features.This chapter discusses the following topics: • Starting and Stopping the BPM Platform• BPS Installation Procedure• BPS Login• BPDS Installation Procedure• BPDS Login• Observing Component Status• Statistics• SNMP Traps• Non-GUI Statistics


Routine Tasks

• Accounting• Error Messages• System Status• Role-Based Access Control (RBAC)• Backup and Restore

Starting and Stopping the BPM PlatformTo start or stop the BPM platform, you must enter command line instructions.

Procedure: Starting the Domain Controller BPMTo start the Domain Controller BPM, enter this command:/<tazz-install-directory>/bin/domaincontroller -start -clean

Procedure: Starting the Other PlatformsTo start platforms other than the Domain Controller BPM, enter this command:/<tazz-install-directory>/bin/start_tazz -clean

Procedure: Stopping the Domain Controller BPMTo stop the Domain Controller BPM, enter this command:/<tazz-install-directory>/bin/domaincontroller -stop -force

Note: When starting a domain, start the components in this order:

Domain Controller BPMStandby Topology Database Server BPMActive Topology Database Server BPMStandby Resource Controller BPMActive Resource Controller BPMDirector BPM


Routine Tasks

Procedure: Stopping the Other PlatformsTo stop platforms other than the Domain Controller BPM, first make sure that the system is not part of a cluster, then enter this command:

/<tazz-install-directory>/bin/stop_tazz -force

Note: When shutting down a domain, shut down the components in this order:

Director BPMStandby Resource Controller BPMActive Resource Controller BPMStandby Topology Database Server BPMActive Topology Database Server BPMDomain Controller BPM

Note: If the platform is part of a cluster, uncluster first.


Routine Tasks

BPS Installation ProcedureFollow the steps in this section to install the BPS.

Procedure: Installing the BPS1. Insert the BPS Installation CD into a drive on your computer. The BPS Client

Installer starts automatically and presents the initial Cisco screen (Figure 3).

Figure 3. Cisco Systems Screen

The system displays the Introduction screen.

2. Click Next to continue. The system displays the license agreement.

3. Click Next to continue. The system displays the Choose Install Folder Screen.

4. The system displays the Choose Shortcut Folder screen. Accept the default location selection and click Next to continue.

5. The system displays the Pre-Installation Summary screen. Review the installation details and click Install to continue.

The system displays the Installing Broadband Policy Studio screen.

6. When the system displays the Install Complete screen, click Next.

bsm_cisco_screen


Routine Tasks

7. The system presents you with options to launch the BPS (Figure 4). Check the option to Launch Studio and click Done.

Figure 4. BPS Post-installation Activities Screen

8. The system launches the BPS. The system displays the Welcome screen (Figure 5).

Figure 5. BPS Welcome Screen

bsm_post_install


Routine Tasks

The Log in screen then appears (Figure 6).

Figure 6. BPS Log In Screen

BPS LoginWhen you see the Log in screen (Figure 6), you can log in to the BPS. Refer to Table 2 to determine the appropriate authentication details for your system.

Table 2. Log in Screen Information

Item Detail Default

User Name that identifies the user. administrator

Password Character string that verifies the user name.

administrator

Domain Controller Host

Name or IP address of the host system where the domain controller is running.

<local_machine>

Domain Controller Port

Port number of the TCP port through which the domain controller communicates with the network.

10000

Application Database Host

Name or IP address of the host system where the application database is running.

<local_machine>

Application Database Port

Port number of the TCP port through which the application database communicates with the network.

10005


Routine Tasks

Procedure: BPS - Logging in to the BPS SystemUse this procedure to log in to the BPS system.

1. Enter your user name in the User text box on the Authentication Screen.

2. Enter your password in the Password text box.

3. Enter the domain controller host name or IP address in the Host text box. Use the host name or IP address that you assigned to the domain controller.

4. Enter the domain controller port number in the Port text box. Use the port number through which you want your domain controller to communicate with the network. This should be the number you assigned during installation (base install port).

5. Enter the application database host name or IP address in the Host text box. Use the host name or IP address that you assigned to the application database.

6. Enter the application database port number in the Port text box. Use the port number through which you want your application database to communicate with the network. This should be the number you assigned during installation (base install port + 5).

Note: Ensure that the default port number is open and available.


Routine Tasks

7. The display is similar to Figure 7. Click Login.

Figure 7. BPS - Completed Log In Screen

The system displays the initial BPS screen.

Figure 8. Initial BPS Screen

Note: Your actual screen may look different from this sample screen.


Routine Tasks

BPDS Installation ProcedureFollow the steps in this section to install the BPDS.

Procedure: Installing the BPDS1. Insert the BPDS Installation CD into a drive on your computer. The BPDS Client

Installer starts automatically and presents the Cisco screen (Figure 9).

Figure 9. Cisco Systems Screen

The system displays the Introduction screen. Click Next to continue.

2. The system displays the license agreement. Click Next to continue.

3. The system displays the Choose Install Folder screen. Accept the default location selection and click Next to continue.

4. The system displays the Choose Shortcut Folder screen. Accept the default location selection and click Next to continue.

5. The system displays the Pre-Installation Summary screen. Review the installation details and click Install to continue.

The system displays the Installing Cisco Broadband Policy Design Studio screen.

6. When the system displays the Install Complete screen, click Next.


Routine Tasks

7. The system presents you with options to launch the BPDS (Figure 10). Check the option to Launch Design Studio and click Done.

Figure 10. BPDS Post-installation Activities Screen

8. The system launches the BPDS. The system displays the Welcome screen (Figure 11)

Figure 11. BPDS Welcome Screen


Routine Tasks

The Log in screen then appears (Figure 12).

Figure 12. BPDS Log In Screen

BPDS LoginWhen you see the Log in screen (Figure 12), you can log in to the BPDS. Refer to Table 3 below to determine the appropriate authentication details for your system.

Table 3. Log in Screen Information

Item Detail Default

User Name that identifies the user. administrator

Password Character string that verifies the user name.

administrator

Domain Controller Host

Name or IP address of the host system where the domain controller is running.

<local_machine>

Domain Controller Port

Port number of the TCP port through which the domain controller communicates with the network.

10000

Application Database Host

Name or IP address of the host system where the application database is running.

<local_machine>

Application Database Port

Port number of the TCP port through which the application database communicates with the network.

10005


Routine Tasks

Procedure: BPDS - Logging in to the BPDS SystemUse this procedure to log in to the BPDS system.

1. Enter your user name in the User text box on the Authentication Screen.

2. Enter your password in the Password text box.

3. Enter the domain controller host name or IP address in the Host text box. Use the host name or IP address that you assigned to the domain controller.

4. Enter the domain controller port number in the Port text box. Use the port number through which you want your domain controller to communicate with the network. This should be the number you assigned during installation (base install port).

5. Enter the application database host name or IP address in the Host text box. Use the host name or IP address that you assigned to the application database.

6. Enter the application database port number in the Port text box. Use the port number through which you want your application database to communicate with the network. This should be the number you assigned during installation (base install port + 5).

Note: Ensure that the default port number is open and available.


Routine Tasks

7. The display is similar to Figure 13. Click Login.

Figure 13. BPDS - Completed Log In Screen

The system displays the initial BPDS screen.

Figure 14. Initial BPDS Screen

Note: Your actual screen may look different from this sample screen.


Routine Tasks

Observing Component StatusYou can observe the status of all BPM components using the BPS, including service engines, agents, and services. This can be useful for determining what is installed, how components are configured, and what state components are in.

Network Administration Tree PaneThe Network Administration Tree pane (Figure 15) presents the network view of BPM objects (service engines, services, and agents) and indicates their status. The Tree pane allows you to choose and view objects in the BPM system.

Figure 15. Sample Network Administration Screen - Tree Pane


Routine Tasks

Service Engine ConfigurationIn the Network Administration view, the Configuration tab page for a service engine displays information about a specific service engine. Use this pane to obtain information on service engines and their databases, change values, and save those values. Figure 16 is an example of the display of the configuration tab page for a service engine. You can change the name of the service engine here.

Figure 16. Sample Configuration Tab Page for Service Engine

If you right-click one of the databases for a service engine, a drop-down menu appears. From this menu you can change connections to the selected database, refresh the information for the selected database, or remove the database from replication.

Figure 17. Database Menu


Routine Tasks

Agent ConfigurationIn the Network Administration view, the Agent Configuration tab page displays information about a specific agent. Use this pane to enter or change agent values, access its Properties dialog box or Devices dialog box, and submit those values to the system. Figure 18 is an example of a configuration tab page for an agent. For details on configuring an agent, see Procedure: Changing Agent Configuration on page 100.

Figure 18. Agent Configuration Tab Page

Service Design Tree PaneYou can view information including Policy Functions and Rules.

Procedure: Viewing Information about Policy FunctionsYou can view information about policy functions, including parameters, source rule, and source script.


Routine Tasks

To view information about policy functions:

1. On the Service Design pane, click the Policies tab under the tree pane. The Policies tree pane appears.

Figure 19. Policies Tree Pane on Service Design Pane

2. Open the Policy Functions folder. The Policy Functions folder opens, showing the currently available policy functions.

Figure 20. Policy Functions Folder on Service Design Pane


Routine Tasks

3. Click a policy function. The selected policy function opens. Information on that policy function appears.

Figure 21. Policy Function Information


Routine Tasks

Table 4 presents the available information.

Procedure: Viewing Information about RulesYou can view information about rules, including author, dependencies, parameters, and script.To view information about rules:

1. On the Service Design pane, click the Policies tab under the tree pane. The Policies tree pane appears.

Figure 22. Policies Tree Pane on Service Design Pane

Table 4. Policy Function Information

Field Label MeaningData Type Details

description description of object string

id unique identifier string 0-32 bytes

name name of object string 1-50 bytes

parameters (policy function)

input and output parameters to the current function

specific to function

source rule rule that is the source of the policy function

source script script logic for the policy function If checked, script can be entered directly in the window.


Routine Tasks

2. Open the Rules folder. The Rules folder opens, showing the currently available rules.

Figure 23. Rules Folder on Service Design Pane


Routine Tasks

3. Click a rule. The selected rule opens. Information on that rule appears.

Figure 24. Rule Information


Routine Tasks

Table 5 presents the available information.

Table 5. Rule Information

Field Label MeaningData Type Details

Author person who wrote the rule string

dependencies (rules)

displays all of the Rules that are called by the current Rule

list

dependents (rules)

displays all of the Rules that the current Rule calls

list

description description of object string

id unique identifier string 0-32 bytes

name name of object string 1-50 bytes

parameters (rule) input and output parameters for the Rule specific to Rule

script


Routine Tasks

StatisticsThe BPS or BPDS allows you to display a variety of system statistics.

Agent StatisticsThe Network Administration Agent Statistics tab page displays statistical information about a selected agent on the BPM system. You can choose certain statistics to plot over time. Figure 25 is an example of an agent statistics tab page display.

Figure 25. Agent Statistics Tab Page Display

Table 6 describes sample agent statistics.

Table 6. Sample Agent Statistics and Details

Statistic Detail

reference-count component reference count.

repository-name Name of object in engine repository.

message-pending Number of messages currently processing.

object-creation-date Time at which object constructor was called.

message-total Total number of messages processed.

pid Process id hosting agent.

message-failed Total number of messages processed unsuccessfully.


Routine Tasks

Other StatisticsYou can examine statistics for other components by clicking the component in the Network Administration Tree pane, and clicking the Statistics tab. Other useful statistics that are available are detailed in the Statistics addendum, a separate document.


Routine Tasks

SNMP TrapsThe Simple Network Management Protocol (SNMP) TCP/IP networks provides a means to monitor and control network devices, and to manage configurations, statistics collection, performance, and security. Using SNMP, the BPM can integrate with a variety of industry standard network monitoring and fault management systems to report statistics, health and fault conditions.The SNMP prefix for TAZZ is 1.3.6.1.4.1.10782. The BPM uses sub category 10. Below that category is an index for the sub-component category, and then another (1) to indicate trap, and the trap type. Traps from the BPM are of the form:

1.3.6.1.4.1.10782.10.<component>.1.<ID>

Table 7 shows the components.

The SNMP codes are:1.3.6.1.4.1.10782.10.20.1.1 // TDS configure1.3.6.1.4.1.10782.10.20.1.2 // TDS startup1.3.6.1.4.1.10782.10.20.1.4 // TDS clear configuration, externally

initiated1.3.6.1.4.1.10782.10.20.1.5 // TDS update or clear statistics

externally initiated1.3.6.1.4.1.10782.10.20.1.6 // initiated failover of a Resource

Controller1.3.6.1.4.1.10782.10.20.1.7 // notified of Resource Controller

startup1.3.6.1.4.1.10782.10.20.1.8 // TDS failover occurred1.3.6.1.4.1.10782.10.20.1.9 // TDS cluster dissolved

1.3.6.1.4.1.10782.10.30.1.1 // Director configure1.3.6.1.4.1.10782.10.30.1.2 // Director startup1.3.6.1.4.1.10782.10.30.1.4 // Director clear configuration,

externally initiated1.3.6.1.4.1.10782.10.30.1.5 // Director update or clear statistics

externally initiated1.3.6.1.4.1.10782.10.30.1.7 // initiated failover of a Resource

Controller (historical - not used)1.3.6.1.4.1.10782.10.30.1.8 // notified of Resource Controller

startup (historical - not used)

Table 7. SNMP Components

20 TDS

30 Director

40 Resource Controller


Routine Tasks

1.3.6.1.4.1.10782.10.40.1.1 // Resource Controller configure1.3.6.1.4.1.10782.10.40.1.2 // Resource Controller startup1.3.6.1.4.1.10782.10.40.1.4 // Resource Controller clear

configuration, externally initiated.

The system also makes use of the Solaris SNMP mechanism to issue traps, in particular for the LinkDown network connectivity loss trap. This trap is useful to detect interface problems on the Link that connects to the SIP Server.

Non-GUI StatisticsStatistics are also available from non-GUI sources, such as log files.

TDS StatisticsThe number of TDS starts:

TDS.start

The number of times the TDS has initiated a failover of a Resource Controller. <IP_Address> represents the IP address of the active Resource Controller.

TDS.resiliency.initiateFailover.<IP_Address>

The number of times the TDS has been notified of Resource Controller startup. <IP_Address> represents the IP address of the active Resource Controller.

TDS.resiliency.notifiedStartup.<IP_Address>

Director StatisticsThe number of Director starts:

SPDF.start

The number of times the Director initiated a failover of a Resource Controller. This exists for historical context. Resource Controller failover is initiated by the TDS.

SPDF.resiliency.initiateFailover

Number of times the Director was notified of Resource Controller startup. Exists for historical context. Directors do not need to be notified of Resource Controller startup.

SPDF.resiliency.notifiedStartup

The QoS interface counters per application function. Action is QosReserve, QosModify, QosRefresh, or QosRelease. Status is the Status code of the deny, for example, 10101 (deny on VC) or 10102 (deny on VP) in most cases.

<ApplicationID>.qos.<Action>.accept.count<ApplicationID>.qos.<Action>.count<ApplicationID>.qos.<Action>.deny.<Status>.count<ApplicationID>.qos.<Action>.deny.count


Routine Tasks

<ApplicationID>.qos.<Action>.error.count<ApplicationID>.qos.<Action>.replay.count

The QoS interface counters in aggregate of all application functions:total.qos.<Action>.accept.counttotal.qos.<Action>.counttotal.qos.<Action>.deny.<Status>.counttotal.qos.<Action>.deny.counttotal.qos.<Action>.error.counttotal.qos.<Action>.replay.count

Resource Controller StatisticsThe number of Resource Controller starts:

ARACF.start

The QoS interface counters per application function. Action is QosReserve, QosModify, QosRefresh, or QosRelease. Status is the Status code of the deny, for example, 10101 (deny on VC) or 10102 (deny on VP) in most cases.

<ApplicationID>.qos.<Action>.accept.count<ApplicationID>.qos.<Action>.count<ApplicationID>.qos.<Action>.deny.<Status>.count<ApplicationID>.qos.<Action>.deny.count<ApplicationID>.qos.<Action>.error.count<ApplicationID>.qos.<Action>.replay.count

The QoS interface counters in aggregate of all application functions:total.qos.<Action>.accept.counttotal.qos.<Action>.counttotal.qos.<Action>.deny.<Status>.counttotal.qos.<Action>.deny.counttotal.qos.<Action>.error.counttotal.qos.<Action>.replay.count

AccountingAccess to the QosServer through the application function (AF) is logged into the application function log file /tazz/logs/<type>.qos.log, where <type> is SPDF (for Directors) or ARACF (for Resource Controllers). Each event includes one or more standard values. Table 8 gives the values.

Table 8. Accounting Events

Value Description

<time> Time of event, in microseconds, since the epoch (Jan 1, 1970 at 12:00 AM), expressed as a decimal number.


Routine Tasks

<ReqID> This is an integer request ID.

<Config-name-prefix> This is the prefix given to the ClearConfiguration API. The service clears all configuration entries that match the prefix. For example, if you have a configuration with “a.b.c=1” and “a.b.d=2”, and the ClearConfiguration is called with <Config-name-prefix> set to “a.b”, then the call clears both entries out of the configuration, and the logged message includes “a.b” in this field.

<Result> This is a result, in the form of an integer code, which, when converted to Hex, is identifiable. The high order byte represents error type: 0 = success 1 = warning 2 = failure

<Config-comma-separated> This is a comma-separated list of the configuration values. Each entry is a name/value pair with a space between the name and the value.

<Stats-comma-separated> This is a comma-separated list of the statistics values. Each entry is a name/value pair with a space between the name and the value.

Version This is “1.0” for this release.

ApplicationId This identifier is used to differentiate various Application Function implementations to the Qos Server. In this release it is “TAZZ.Qos”.

TransactionId This uniquely identifies a message sent to a particular Interface. This identifier is used to provide correlation capability for failure management and mediation. The uniqueness of a transaction ID is possibly different per interface.

ContextId This parameter uniquely identifies a context containing the media streams. This identifier should be globally unique.

Src This is the source of the operation, in the form ip@VPN. The IP address is in IPv4 format. Thus a sample src value is 192.9.100.3@VPN.

Dst This is the destination of the operation, in the form ip@VPN. The IP address is in IPv4 format. Thus a sample dst value is 192.9.100.4@VPN.

Table 8. Accounting Events (continued)


Routine Tasks

Endpoints The Endpoints field is a list of endpoint pairs. Each pair of endpoints is itself a list composed of a source endpoint followed by a destination endpoint. Each of the source and destination endpoints is a list of 4 items as described below:1) Address: This is the address of the endpoint of the media. The flows are forward/reverse/bi-directional with respect to this address. This is an IP address (IPv4).2) VPN: This is the identifier of the endpoint's VPN. This provides localized uniqueness to the Source Address if needed, and may be omitted if the Application does not require this level of segmentation.3) ID: This identifies the endpoint in the TIM. This is not initially known, and may not be specified, but it is resolved later and the information can be used to bypass additional duplicate resolution if the information is known to be relevant to the local topology.4) Realm: This identifies the realm to which this endpoint belongs. If this information is present in a request, it represents the calling function's concept of realm, which may be refined by the receiver when handling the request.

Lease This is the number of seconds for the reservation to remain valid.For a refresh message, the lease parameter is ignored. During a refresh, the lease is accepted. After refreshing the reservation, the orignal lease value is returned.For a modify, the lease is changed to the new passed value, provided it meets internal criteria. The request is always accepted, but if 0 is requested, the default of 200 is returned. The actual value kept internally is then returned.The lease is refreshed during any API call involving a context. It is valid for "Lease" more seconds after the reserve, modify, or refresh.

Priority This is the specified priority of the context. This is a string.



Routine Tasks

A minimum of two messages are logged for each function call to the application function (AF). Messages are logged on ingress and egress to an application function. If an error occurred an additional error message is logged that contains additional diagnostic information. The format for each message type is described below. In general, each message format has one of three forms:

<time>, ENTER, <reqType>, <reqID>, <input1>, ..., <inputN><time>, EXIT, <reqType>, <reqID>, <output1>, ..., <outputN><time>, INTERNAL, <reqType>, <reqID>, <event>, <prop1>, ..., <propN>

Particular log entries vary depending upon the inputs to the function, and are identified in the per-message details below. Additionally, one of the following statements should also appear as the last entry in any rolled log file, to indicate the particular cause of the rollover:

<time>, FAILOVER<time>, SYNC<time>, ROLLOVER<time>, UNDEPLOY<time>, RESET

The FAILOVER statement occurs only on the active system of a Resource Controller cluster, when a failover occurs and the system is shutting down.

Flows A flow descriptor is a set of attributes describing a unidirectional media flow from defined source to defined destination. Each flow contains flow-id, direction, source-port, destination-port, flow-capacity-descriptor, dscp, and carried application id. Flows are not valid for Refresh and Release messages, and are represented as empty parameters.

ResourceId Indicates the resource type (vp or vc) and an id unique to that type of resource.

SessionId This is an address in the form ip@VPN, similar to the definition of the Src and Dst fields.

FullContextId This is a string of the form “realm RESOURCE {context <ContextID>}"

Role “none”, “active” or “inactive”

Status This is the status code for the operation. These are base-10 values.



Routine Tasks

The SYNC statement occurs only on the standby system of a Resource Controller cluster, after successfully connecting to the active system and just prior to synchronizing their log file contents. The ROLLOVER statement occurs whenever the log file is rolled over during normal operating procedures, whether due to the configured automatic rollover settings or due to a manual or scheduled invocation of the rolloverLog operator. The UNDEPLOY statement occurs whenever the LogAgent is undeployed.The RESET statement occurs if the configured log file already exists when the agent is deployed.

Director Accounting Log MessagesThe following messages are generated to the Director log file:

<time>, ENTER, ClearConfiguration, <ReqID>, <Config-name-prefix><time>, EXIT, ClearConfiguration, <ReqID>, <Result>

<time>, ENTER, ClearStatistics, <ReqID>, <Config-name-prefix><time>, EXIT, ClearStatistics, <ReqID>, <Result>

<time>, ENTER, Configure, <ReqID>, <Config-comma-seperated><time>, EXIT, Configure, <ReqID>, <Result>

<time>, ENTER, IncrementStatistics, <ReqID>, <Stats-comma-seperated>

<time>, EXIT, IncrementStatistics, <ReqID>, <Result>

<time>, ENTER, UpdateStatistics, <ReqID>, <Stats-comma-seperated><time>, EXIT, UpdateStatistics, <ReqID>, <Result>

<time>, ENTER, StartServer, <ReqID><time>, EXIT, StartServer, <ReqID>, <Result>

<time>, ENTER, QosReserve, <ReqID>, <Version>, <ApplicationID>, <TransactionID>, <ContextID>, <Src>,<Dst>, <Lease>, <Priority>, <Flows>

<time>, EXIT, QosReserve, <ReqID>, <Status>, <Lease>

<time>, ENTER, QosModify, <ReqID>, <Version>, <ApplicationID>, <TransactionID>, <ContextID>, <Src>,<Dst>, <Lease>, <Priority>, <Flows>

<time>, EXIT, QosModify, <ReqID>, <Status>, <Lease>

<time>, ENTER, QosRefresh, <ReqID>, <Version>, <ApplicationID>, <TransactionID>, <ContextID>, <Src>,<Dst>, <Lease>, <Priority>, <Flows>

<time>, EXIT, QosRefresh, <ReqID>, <Status>, <Lease>


Routine Tasks

<time>, ENTER, QosRelease, <ReqID>, <Version>, <ApplicationID>, <TransactionID>, <ContextID>, <Src>,<Dst>, <Lease>, <Priority>, <Flows>

<time>, EXIT, QosRelease, <ReqID>, <Status>, <Lease><time>, ENTER, RCStartup, <ReqID>, RC-Resource<time>, EXIT, RCStartup, <ReqID>, <Result>

Resource Controller Accounting Log MessagesThe following messages are generated to the Resource Controller log file:

<time>, ENTER, ClearConfiguration, <ReqID>, <Config-name-prefix><time>, EXIT, ClearConfiguration, <ReqID>, <Result><time>, ENTER, ClearStatistics, <ReqID>, <Config-name-prefix><time>, EXIT, ClearStatistics, <ReqID>, <Result><time>, ENTER, Configure, <ReqID>, <Config-comma-seperated><time>, EXIT, Configure, <ReqID>, <Result><time>, ENTER, IncrementStatistics, <ReqID>,

<Stats-comma-seperated><time>, EXIT, IncrementStatistics, <ReqID>, <Result>

<time>, ENTER, UpdateStatistics, <ReqID>, <Stats-comma-seperated><time>, EXIT, UpdateStatistics, <ReqID>, <Result>

<time>, ENTER, StartServer, <ReqID><time>, INTERNAL, StartServer, <ReqID>, InitializeCtf, <Result><time>, EXIT, StartServer, <ReqID>, <Result>

<time>, ENTER, StartSession, <ReqID>, AccessAddress<time>, INTERNAL, StartSession, <ReqID>, CreateSessionID,

<SessionID><time>, EXIT, StartSession, <ReqID>, <Result>

<time>, ENTER, StopSession, <ReqID>, AccessAddress<time>, INTERNAL, StopSession, <ReqID>, CreateSessionID, <SessionID><time>, EXIT, StopSession, <ReqID>, <Result>

<time>, ENTER, ContextTimeout, <ReqID>, <Full-ContextID><time>, INTERNAL, ContextTimeout, <ReqID>, TimestampMatch,

<ContextID><time>, EXIT, ContextTimeout, <ReqID>, <Result>

<time>, ENTER, Failover, <ReqID>, <State><time>, INTERNAL, Failover, <ReqID>, CurrentRole, <Role><time>, INTERNAL, Failover, <ReqID>, InitializeCtf, <Result><time>, EXIT, Failover, <ReqID>, <Result>

<time>, ENTER, QosReserve, <ReqID>, <Version>, <ApplicationID>, <TransactionID>, <ContextID>, <Endpoints>, <Lease>, <Priority>, <Flows>

<time>, EXIT, QosReserve, <ReqID>, <Status>, <Lease>


Routine Tasks

<time>, ENTER, QosModify, <ReqID>, <Version>, <ApplicationID>, <TransactionID>, <ContextID>, <Endpoints>, <Lease>, <Priority>, <Flows>

<time>, EXIT, QosModify, <ReqID>, <Status>, <Lease>

<time>, ENTER, QosRefresh, <ReqID>, <Version>, <ApplicationID>, <TransactionID>, <ContextID>, <Endpoints>, <Lease>, <Priority>, <Flows>

<time>, EXIT, QosRefresh, <ReqID>, <Status>, <Lease>

<time>, ENTER, QosRelease, <ReqID>, <Version>, <ApplicationID>, <TransactionID>, <ContextID>, <Endpoints>, <Lease>, <Priority>, <Flows>

<time>, EXIT, QosRelease, <ReqID>, <Status>

Error MessagesThe BPS displays certain BPM error messages.

Log PaneThe Log pane (Figure 26) presents informational and error messages. This information can be useful for reviewing operations and for investigating problems.

Figure 26. Sample Log Pane Content

Log MessagesIn addition to the messages that the BPS displays, there are many log warning, error and fatal messages generated by components of the BPM platform. The BPM platform, or backend, is composed of many components. Each component has the ability to log information into the BPM system log file. As of version 1.5 of the backend, this log file is named tazz.log, and is located in the /opt/tazz/logs directory. To view the file, enter the command:

tail -f /opt/tazz.log

or:more tazz.log

A complete list of log messages is available in the separate Log Messages addendum and the Application Log Messages addendum.


Routine Tasks

Log File FormatThe format of the log file is uniform to facilitate automated processing. The format is as follows:

<log-file>::= <log-line>*<log-line>::= <log-entry><crlf><crlf> ::= ‘\r\n’<log-entry>::= <date> <sp> <host> <sp> <obr> <port> <cbr> <sp> <obr>

<severity> <cbr> <sp> <obr> <class> <cbr> <msg><date>::= DDD MMM HH:MM:SS TZ YYYY (HH is 24 hr)<sp>::= ‘ ‘<host>::= {host on which BPM is installed}<obr>::= ‘[‘<cbr>::= ‘]’<port>::= {port}<severity>::= (‘DEBUG’ | ‘INFO’ | ‘WARN’ | ‘ERROR’ ‘FATAL’)<class>::= {fully qualified namespace of component logging event}<msg>::= <text-line>+<text-line>::= <text><crlf><text>::= {ascii text}

Severity DefinitionsLog entries are classified with one of the following severities:DEBUG: BPM internal instrumentationINFO: subsystem has changed state (e.g., user has logged in)WARN: an abnormal condition arose, which did not affect the processing of the current request.ERROR: an abnormal condition arose, which did or may prevent the completion of the current request. The system is able to continue processing requests.FATAL: an abnormal condition arose, which prevents the subsystem from processing further requests. The affected subsystem is being shut down and restarted.

Example Log EntryMon Dec 20 17:12:50 EST 2004 localhost [4010] [ERROR] [com.tazz.eventdispatcher.SocketAdapter] Error occurred accepting connection: Socket closed

System StatusYou can observe system status information.


Routine Tasks

Status BarThe Status bar (Figure 27) provides system information.

Figure 27. Sample Status Bar Content


Routine Tasks

Role-Based Access Control (RBAC)The Role-Based Access Control (RBAC) function of the BPM allows administrators to control user access to actions and data in the BPM BPS. This section describes the elements of the BPM RBAC and shows how administrators can use RBAC for managing user permissions.

Elements of the BPM RBAC The BPM RBAC allows access to be controlled based on the roles that individual users are assigned. This section describes the elements of the BPM RBAC model: • Roles• Users• Resources• Actions• Permissions

RolesA role is a job function within the context of an organization, along with the authority and responsibility conferred on the user assigned to the role. For example, an agent monitor role is granted the permission to view agent statistics, but is denied permissions to perform other actions on agents, for example, deploy, undeploy, and modify.

UsersA user is a person using the BPM BPS. Users are assigned to one or more roles.

ResourcesA resource is anything in the BPM BPS that is subject to access control. Examples of resources are Report Manager and service engines.

ActionsAn action is any task that a user can perform in the BPM BPS that is subject to access control. An action is performed on a resource. Examples of such actions are: deploy Agents, modify Agents, and Use Network Admin View.


Routine Tasks

PermissionsRoles are granted or denied permission to perform an action. For example, the agent monitor role is denied permission to perform the deploy Agents action.

Per-user OverridesBy default, a user has the same permissions as the roles to which he is assigned. However, user permissions can be overridden to be different from those of his assigned roles. For example, a user with the agent monitor role, by default, is denied permission to perform the deploy Agents action. An administrator can grant a user the deploy Agents permission without granting the same permission to every user with the same roles.

User Belonging to Multiple RolesIf a user belongs to more than one role, and these roles have conflicting permissions on the same action, then a deny takes precedence over a grant. For example, a user may be assigned two roles, agent monitor and agent deployer. Although the agent monitor role denies permission to deploy Agents, the agent deployer role grants permission to deploy Agents. In this case, the user is denied permission to deploy Agents (unless there is a separate per-user override granting permission to deploy Agents).


Routine Tasks

Using RBACYou can use RBAC to arrange access in a variety of ways. This section describes the RBAC display and how to use it to accomplish common tasks.

Starting RBACTo start RBAC, follow these steps:

1. From the BPS, choose Tools --> RBAC Administration (Figure 28).

Figure 28. Selecting RBAC Administration


Routine Tasks

2. The RBAC window appears (Figure 29).

Figure 29. Main RBAC Display

This window displays a tree diagram that can include current RBAC domains, users, and roles.


Routine Tasks

RolesYou can view all the currently defined roles and the access details that each role defines. You can also create new roles, and modify or delete existing roles.

Creating RolesTo create a new role, follow these steps:

1. In the RBAC window, right-click on the Roles folder (Figure 30).

Figure 30. Roles Folder

2. Click New Role. Alternatively, you can choose File --> New Role (Figure 31).

Figure 31. Creating New Role

Alternatively, you can click the New Role icon, above the tree diagram.


Routine Tasks

3. The New Role dialog appears. Enter a Name for the new role, and click OK (Figure 32).

Figure 32. New Role Dialog

4. The new role is created. You can optionally enter a description of this role in the Description field on the General tab, then click Submit (Figure 33).

Figure 33. General Tab for Roles

SG_RBROLADMGEN

General tab


Routine Tasks

5. To grant and deny permissions for the new role, click the Permissions tab (Figure 34).

Figure 34. Granting and Denying Permissions

A tree of available permissions appears. For each permission, check Grant or Deny.

Permissions are color coded as follows:

• Green: the permission is explicitly granted or denied.• Gray: the default value of the permission.

6. Click a gray or blank permission. It becomes green to show that you selected it explicitly. Click a green permission, to reset the default permission to gray.

7. When finished with permissions, click Submit.

SG_RBROLADMPER

Permissions tab


Routine Tasks

Viewing and Modifying RolesTo view or modify existing roles, follow these steps:

1. From the Roles folder, choose the role to view or modify (Figure 35).

Figure 35. Selecting Role

2. If not selected, click the General tab. This shows the current Name and Description of the role. You can change the name of the role by modifying the text in the Name field. You can create or modify the description of the role by entering the text in the Description field. Click Submit when finished.

Roles folder


Routine Tasks

3. If not selected, click the Users tab. This shows the users who currently have this role (Figure 36).

Figure 36. Users for Role

SG_RBROLUSE

Users tab


Routine Tasks

4. To add or remove users for a role, click Modify User Assignments (Figure 36). The user assignments window for this role appears (Figure 37).

Figure 37. User Assignments Window

5. To add a user to this role, choose the user from the Not assigned list and click the right-arrow (Figure 37). To remove a user from this role, choose the user from the Assigned list and click the left-arrow.

Click Submit when finished. The result of your changes appears on the Users tab.

Caution: Removing a user from a role may prevent that user from performing necessary tasks.

SG_RBUSERASS


Routine Tasks

6. If not selected, click the Permissions tab. This shows the permissions for this role (Figure 38).

Figure 38. Permissions for Role


• Green: the permission is explicitly granted or denied.• Gray: the default value of the permission.

7. To change permissions for this role, click Grant or Deny for the permission you wish to change (Figure 38).

If you click a gray or blank permission, it becomes green to show that you selected it explicitly. If you click a green permission, the default permission resets to gray.

8. Click Submit when finished.

Caution: Changing permissions for a role may prevent users with that role from performing necessary tasks.

SG_RBROLADMPER

Permissions


Routine Tasks

Deleting RolesTo delete a role, follow these steps:

1. Right-click the role to delete from the tree list, and choose Delete Role (Figure 39).

Figure 39. Deleting Role

2. The Confirm Role Deletion dialog appears (Figure 40). Click Yes. The role is deleted.

Figure 40. Confirming Role Deletion

UsersYou can view all the users and their roles and permissions. You can also create new users and modify or delete existing users.

Caution: Deleting a role may prevent users with that role from performing necessary tasks.


Routine Tasks

Creating UsersTo create a new user, follow these steps:

1. In the RBAC window, right-click on the Users folder (Figure 41).

Figure 41. Users Folder

2. Click New User.

Alternatively, you can choose File --> New User (Figure 42).

Figure 42. Creating New User

Alternatively, you can click the New User icon, above the tree diagram.


Routine Tasks

3. The New User dialog appears (Figure 43). Enter a Name for the new user. Enter and confirm a Password for the new user. When finished, click OK.

Figure 43. New User Dialog

4. The new user is created. On the General tab, you can optionally enter the name of the user in the Full Name field, the user’s e-mail address in the e-mail address field, or a description of this user in the Description field, then click Submit (Figure 44).

Figure 44. General Tab for Users

SG_RBUSEADMGEN


Routine Tasks

5. To assign roles for the new user, click the Roles tab (Figure 45).

Figure 45. Assigning Roles

SG_RBUSEROL


Routine Tasks

6. To add or remove roles for a user, click Modify Role Assignments. The role assignments window for this user appears (Figure 46).

Figure 46. Role Assignments Window

7. To add a role for this user, choose the role from the Not assigned list and click the right-arrow. To remove a role from this user, choose the role from the Assigned list and click the left-arrow.

8. Click Submit when finished. The result of your changes appears on the Roles tab.

Caution: Removing a role from a user may prevent that user from performing necessary tasks.

SG_RBROLASS


Routine Tasks

9. To grant and deny permissions for the new user, click the Permissions tab (Figure 47).


A tree of available permissions appears.

10. For each permission, check Grant or Deny. This granting or denying applies only to the selected user. If the same permission should be granted or denied to everyone with the same role as this user, change the permission for the role, not for the individual user.


• Orange: the permission is inherited from one of the roles of the user.• Green: the permission is overridden for this user.• Gray: the default value of the permission.

In addition, some permissions appear without a checkbox. These permissions are read-only, and cannot be changed. This is done to prevent, say, an administrator from locking himself out of the system.

If you click an orange, gray, or blank permission, it becomes green to show that you selected it explicitly. If you click a green permission, the original inherited or default permission resets to orange or gray.

SG_RBUSEPER


Routine Tasks


Viewing and Modifying UsersTo view or modify existing users, follow these steps:

1. From the Users folder, click the user to view or modify (Figure 48).

Figure 48. Selecting User

2. If not selected, click the General tab (Figure 48). This shows the current Login ID, Full Name, e-mail address, and Description of the user. You can change any of these items by modifying the text in the field. Click Submit when finished.

SG_RBUSEGEN


Routine Tasks

3. To view or modify roles for the user, click the Roles tab (Figure 49).

Figure 49. Assigning Roles

SG_RBUSEROL


Routine Tasks

4. To add or remove roles for a user, click Modify Role Assignments. The role assignments window for this user appears (Figure 50).

Figure 50. Role Assignments Window

5. To add a role for this user, choose the role from the Not assigned list and click the right-arrow. To remove a role from this user, choose the role from the Assigned list and click the left-arrow.

6. Click Submit when finished. The result of your changes appears on the Roles tab.

Caution: Removing a role from a user may prevent that user from performing necessary tasks.

SG_RBROLASS


7. To grant and deny permissions for a user, click the Permissions tab (Figure 51).


A tree of available permissions appears.

8. For each permission, check Grant or Deny. This granting or denying applies only to the selected user. If the same permission should be granted or denied to everyone with the same role as this user, change the permission for the role, not for the individual user.


• Orange: the permission is inherited from one of the roles of the user.• Green: the permission is overridden for this user.• Gray: the default value of the permission.

In addition, some permissions appear without a checkbox. These permissions are read-only, and cannot be changed. This is done to prevent, for example, an administrator from locking himself out of the system.

If you click an orange, gray, or blank permission, it becomes green to show that you selected it explicitly. If you click a green permission, the original inherited or default permission resets to orange or gray.

SG_RBUSEPER

Routine Tasks


10. To change the password for a user, click the Change Password tab (Figure 52).

Figure 52. Changing Password

11. Enter and confirm the New Password, then click Submit. The password is changed.

Caution: Changing permissions for a user may prevent that user from performing necessary tasks.

Caution: Changing a user password may prevent that user from performing necessary tasks.

SG_RBUSEPAS


Routine Tasks

Deleting UsersTo delete a user, follow these steps:

1. Right-click the user to delete from the tree list, and choose Delete User (Figure 53).

Figure 53. Deleting User

2. The Confirm User Deletion dialog appears (Figure 54). Click Yes. The user is deleted.

Figure 54. Confirming User Deletion

Caution: Deleting a user may prevent that user from performing necessary tasks.


Routine Tasks

Importing and Exporting RBAC DataYou can export RBAC data, to preserve the users, roles, and permissions that you have defined. You can also import RBAC data, either to recover changed or lost data, or to duplicate existing definitions.

Exporting RBAC DataTo export RBAC data, follow these steps:

1. Click the Export Rbac data icon (on right in Figure 55), or choose File --> Export.

Figure 55. Export RBAC Data Icon

2. The Export dialog appears (Figure 56). Move to the directory where you want to save the data. Check which data to export from the following choices:

•Users•Roles•User-to-Role Assignments•User Permissions•Role Permissions

3. Enter a name for the data file. Click Export.

Figure 56. Exporting Data

The selected data is exported to the data file.

SG_RBEXP


Importing RBAC DataTo import RBAC data from an existing data file, follow these steps:

1. Click the Import Rbac data icon (on left in Figure 57).

Figure 57. Import RBAC Data Icon

Alternatively, you can choose File --> Import.

2. The Import dialog appears (Figure 58). Move to the directory where the data file is located. Choose which data file to import. Click Import.

Figure 58. Importing Data

The selected data is imported to RBAC.

Backup and RestoreThe export and import functions allow the administrator to save internal data from the database to an external file, or to load data from an external file to the database. They do not backup or restore data, in the sense of copying data to secondary media for safekeeping.

SG_RBIMP

Routine Tasks

You can backup (export) and restore (import) various sets of data using the BPS. From the Tools Menu, click Export or Import and choose the specific data set from the drop-down menu. (In the Network Administration view, you can also right-click a service engine, and choose Import from the drop-down menu.)You can export system data. You can also export metadata. You can export data from a specific search engine, by right-clicking the service engine in Network Administration view, then choosing Export subtree from the drop-down menu.To copy the agents and services of one service engine to a second service engine, right-click the original service engine and click Copy configuration from the drop-down menu. Follow the prompts to choose the second service engine.

What’s Next?There are other ways to perform tasks besides using the GUI. Chapter 4, Non-GUI Interfaces, describes these other procedures.


Non-GUI Interfaces

3

Non-GUI Interfaces

OverviewThis section discusses procedures you can perform without using the BPS, including the following topics:• Portal• Accounting Functions• Q-shell Command Line Utility• Statistics

PortalThe Web-based portal allows you to display information and perform operations.


Non-GUI Interfaces

Portal AccessTo access the portal, enter the portal URL in a Web browser.

Figure 59. Sample Portal

The portal displays navigation information at the top of the screen. You can navigate to information about nodes, links, and resources by clicking any available links. You can also search for the names of specific links, nodes, and resources.

Procedure: Searching for Links, Nodes, and ResourcesYou can search for the the name of links, nodes, and resources by following these steps:

1. Right-click the Search drop-down list, and choose Links, Nodes, or Resources from the drop-down list.

2. In the Search text box, type the text to search for and click Go.

Note: You cannot use wildcards in the Search text box.


Non-GUI Interfaces

The portal displays items that match your search text in a list. You can observe the Status of each item in the list.

Figure 60. Results of Search

If there are no matches for your search, the portal displays the following message:

0 results for your query.

3. To view specific information on an item, click the item .

Portal InformationYou can examine various other kinds of information using the portal.

Procedure: Displaying Resource InformationYou can display information about resources by following these steps:

1. Navigate to the resource by clicking the appropriate links.

2. The portal displays information on the resource.


Non-GUI Interfaces

For a VC, this information includes Used, Capacity, and percent. The portal also displays nodes and links associated with this resource.

Figure 61. VC Information


Non-GUI Interfaces

For a VP, this information includes Used, Capacity, and percent. The portal also displays nodes and links associated with this resource.

Figure 62. VP Information


Non-GUI Interfaces

For a session, this information includes creation and update time, access point address and ID, and entry point address and ID. The portal also displays nodes and links associated with this resource.

Figure 63. Session Information

Procedure: Displaying Node InformationYou can display information about nodes by following these steps:

1. Navigate to the node by clicking the appropriate links.

2. The portal displays information on the node.


Non-GUI Interfaces

This information includes the node status, any links originating or terminating at the node, and any attached resources.

Figure 64. Node Information

Procedure: Displaying Link InformationYou can display information about links by following these steps:

1. Navigate to the link by clicking the appropriate links.

2. The portal displays information on the link.


Non-GUI Interfaces

This information includes the link status, the source and destination nodes, and any associated resources.

Figure 65. Link Information

Portal OperationsYou can perform a variety of operations using the portal.

Accounting FunctionsYou can configure accounting functions. This includes options to:• specify the accounting log rollover rate, FTP destination, and configuring a

service • view accounting log file locations • set accounting log file locations


Non-GUI Interfaces

Q-shell Command Line UtilityThis section describes the commands that are available within the qssh.

Invoking qsshInvoke the qssh by entering this command:

qssh

helpDisplays help on a specified topic. If <topic> is omitted, all available help topics are displayed.Usage: help [<topic>]

StartSessionIndicate that a session has started.Usage: StartSession <access-point-address> <access-point-id> <entry-point-id>

where:

<access-point-address> is of the form UserIP@VPN, such as 1.1.1.1@vpn1

<access-point-id> is a string of the form BRASIP/PORT/VPI/VCI

<entry-point-id> is the BRAS ID

StopSessionIndicate that a session has stopped.Usage: StopSession <access-point-address> <access-point-id> <entry-point-id>

where:

<access-point-address> is of the form UserIP@VPN, such as 1.1.1.1@vpn1

<access-point-id> is a string of the form BRASIP/PORT/VPI/VCI

<entry-point-id> is the BRAS ID

ShowSessionsDisplays a list of active sessionsUsage: ShowSessions


Non-GUI Interfaces

ShowResourcesDisplays resources for VP, VC and Context resource layers, or all if no arguments are specified.Usage: ShowResources [resource-type]

ShowNodesDisplays list of nodes and attributesUsage: ShowNodes

ShowLinksDisplays list of links and attributesUsage: ShowLinks

ShowStatsDisplays statistics for those names provided or all if no statistic names are specified.Usage: ShowStats [statistic-name]

ShowTimeoutsDisplays timeouts that are in affect.Usage: ShowTimeouts

RemoveAllLinksRemoves all the Links from the TIM.Usage: RemoveAllLinks

RemoveAllNodesRemoves all the Nodes from the TIM.Usage: RemoveAllNodes

RemoveAllResourcesRemoves all the Resources from the TIM.Usage: RemoveAllResources

ClearTopologyClears the TIM, by removing all links, nodes, and resources.Usage: ClearTopology


Non-GUI Interfaces

TimeoutCause a timeout to occur.Usage: Timeout

qosConfigureUsage: qosConfigure <configuration>

qosGetConfigurationUsage: qosGetConfiguration <args>

qosStartServerThis command starts the QoS server.Usage: qosStartServer

Environment VariablesThe qssh shell is started up with the set of BPM environment variables. For a list type:% env | grep ^TAZZ

StatisticsYou can view statistics, some of which are available in log files. Statistics available include:• number of Director starts• number of times the Director has initiated a failover of a Resource Controller• number of times the Director has been notified of Resource Controller startup • QoS interface counters per application function • qos interface counters in aggregate of all application functions• number of Resource Controller starts

What’s Next?Besides day-to-day operations tasks, there are also maintenance tasks to perform as needed. Chapter 4, Maintenance Tasks, describes these tasks.


Maintenance Tasks

4

Maintenance Tasks

OverviewMaintenance tasks include making changes to the initial setup of the Broadband Policy Manager (BPM) system. This may include adding, configuring, or removing components such as service engines, agents, or services. You can perform many maintenance tasks using the Broadband Policy Studio (BPS). The BPS gives a visible picture of the current BPM Configuration. The BPS uses standard windowing techniques and editing features.This chapter discusses the following topics: • Director Procedures• Resource Controller Procedures• Deploying Components• Configuring Components• Clusters and Failover


Maintenance Tasks

Director ProceduresThere are several procedures you can perform with Directors.

Adding a Director Once a running domain controller and topology database server are in place, and the topology database server has initial provisioning data loaded, you can add Director systems into the domain.To add a Director, follow these steps:

1. Install a backend, as described in the Cisco Broadband Policy Manager Installation and Configuration Guide.

2. Install the director application on the system, following the directions in the Cisco Broadband Policy Manager Installation and Configuration Guide. This procedure also adds a service engine to the Director. This action generates a "join-domain" event, which gets intercepted by the topology database server on the Domain Controller event bus.

3. Copy the Director service engine template to the system, and deploy all the agents and services, by following these steps:

a. Using the BPS, reconnect to the Domain Controller and the Domain Controller's policy database.

b. Right-click the Director Template service engine and choose Copy to Service Engine from the drop-down list. The Copy Engine dialog appears.

c. Select all Director systems, including primary and secondary systems, and click Next. This copies the agents and services from the Director template system to each of the Director systems in the installation. Complete the Copy Engine dialog.

The topology database server then does the following:• automatically configures the system as a Director (loading the configuration from

the resource in the domain realm)• copies the Director realm to the target system, including the provisioned pool

information and Resource Controller to BRAS mappings• starts the server on the target Director system, by invoking the

dir_operations/StartServer service• updates the health of the Director to 0, indicating proper operation of the Director


Maintenance Tasks

• notifies the load balancer that the Director is available to receive requests • adds the Director's IP address to the in-memory "director set".

Removing a Director To manually remove a Director, follow these steps:

1. Update the load balancer to not use the Director.

2. Update the topology database server to set the health of the Director to -1 (unavailable).

3. Wait for about a minute, in case there are pending requests.

4. Shut down the Director.

Resource Controller ProceduresThere are several procedures you can perform with Resource Controllers.

Adding Resource ControllerOnce the domain controller, topology database server, and Directors are in place, you can add Resource Controllers.To add a Resource Controller, follow these steps:

1. Install a backend, as described in the Cisco Broadband Policy Manager Installation and Configuration Guide.

2. Install the Resource Controller application on the system, following the directions in the Cisco Broadband Policy Manager Installation and Configuration Guide. This procedure also adds a service engine to the Resource Controller. This action generates a "join-domain" event, which gets intercepted by the topology database server on the Domain Controller event bus.

3. Copy the Resource Controller service engine template to the system, and deploy all the agents and services, by following these steps:

a. Using the BPS, reconnect to the Domain Controller and the Domain Controller's policy database.

b. Right-click the Resource Controller Template service engine and choose Copy to Service Engine from the drop-down list. The Copy Engine dialog appears.


Maintenance Tasks

c. Select all Resource Controller systems, including primary and secondary systems, and click Next. This copies the agents and services from the Resource Controller template system to each of the Resource Controller systems in the installation. Complete the Copy Engine dialog.

The topology database server then does the following:• automatically configures the system as a Resource Controller (loading the

configuration from the resource in the domain realm)• copies the appropriate R-Realms to the target system, including port information

and VP and VC capacities • starts the server on the target Resource Controller system, by invoking the

rc_operations/StartServer service• updates the health of the Resource Controller to 0, indicating proper operation of

the Resource Controller

Removing a Resource ControllerTo remove a Resource Controller, follow these steps:

1. If the Resource Controller is a cluster primary, initiate failover from the topology database server.

2. If the Resource Controller is a cluster secondary, set the _health of it to -1 (unavailable).

3. If the Resource Controller is a standalone, remove all pool maps that reference R-Realms on that Resource Controller, and then wait for all activity on that Resource Controller to stop.

4. Remove all R-Realms from the Resource Controller. You can add those R-Realms to other Resource Controllers.

5. Remove the Resource Controller resource from Director Realm.

Starting Resource ControllerIf a Resource Controller is a former cluster primary, you can reset the Resource controller from the BPS.


Maintenance Tasks

Deploying ComponentsYou can deploy all BPM components using the BPS, including service engines, agents, and services.

Procedure: Deploying an AgentYou can deploy an agent using the following procedure:

1. In the Network Administration Tree pane, right-click an agent that is not deployed. A drop-down menu of commands appears (Figure 66).

Figure 66. Tree Pane Commands for Agents

2. Choose the Deploy command from the drop-down menu. The agent is deployed.

Note: To deploy all agents for a service engine, right-click the Agents folder under the service engine and click Deploy all from the drop-down menu.


Maintenance Tasks

Procedure: Undeploying an AgentYou can undeploy an agent using the following procedure:

1. In the Network Administration Tree pane, right-click a deployed agent. A drop-down menu of commands appears (Figure 67).

Figure 67. Tree Pane Commands for Agents

2. Choose the Undeploy command from the drop-down menu. Alternatively, on the Configuration tab, click the Undeploy button.

The system displays a progress dialog box while undeploying the agent. When the system undeploys the agent, the running instance of the agent is deleted from the system, and the system displays an Agent object. The state field indicates that the agent is Ready. The Deploy button is enabled.

Note: If you attempt to submit changes to an agent before you undeploy the agent, the system prompts you to undeploy the agent.

Note: If the undeployment is unsuccessful, you receive a message explaining how to undeploy the agent.


Maintenance Tasks

Procedure: Deploying a ServiceFollow the steps below to deploy a service:

1. Click Network Administration and open the Services folder. Click the service to deploy. The State should be Ready for deployment (Figure 68).

Figure 68. Service Ready for Deployment

2. Click the Deploy button to deploy the service. You receive a message that the system is deploying the service.

Note: To undeploy all agents for a service engine, right-click the Agents folder under the service engine, and click Undeploy all from the drop-down menu.

State


Maintenance Tasks

When the State condition changes to Deployed, the service is working (Figure 69).

Figure 69. Service - Deployed

Note: To deploy all services for a service engine, right-click the Services folder under the service engine and click Deploy all from the drop-down menu.

State: Deployed


Maintenance Tasks

Procedure: Undeploying a ServiceFollow the steps below to undeploy a service:

1. Click Network Administration and open the Services folder. Click the service to undeploy. The State should be Deployed (Figure 70).

Figure 70. Deployed Service

2. Click the Undeploy button to undeploy the service. You receive a message that the system is undeploying the service.

State: Deployed


Maintenance Tasks

The State condition changes to Ready for deployment (Figure 71). You can now make changes to the service, then deploy the service again.

Figure 71. Service Ready for Deployment

Note: To make a change to an agent, you must first undeploy the service, then undeploy the agent.

Note: To undeploy all services for a service engine, right-click the Services folder under the service engine and click Undeploy all from the drop-down menu.

State:Ready


Maintenance Tasks

Configuring ComponentsYou can use the BPS to configure BPM components.

Procedure: Configuring a Standby Service EngineA standby service engine acts as a standby to an active service engine in case of failover. You can configure an existing service engine to have a standby service engine using the following procedure:

1. In the Network Administration Tree pane, right-click a service engine. This service engine becomes the active service engine. A drop-down menu of commands appears (Figure 72).

Figure 72. Create Cluster Command


Maintenance Tasks

2. Choose the Create cluster command from the drop-down menu. The Configure Standby Engine dialog box appears (Figure 73).

Figure 73. Configure Standby Engine Dialog Box

3. Click the down arrow, and choose the standby service engine from the drop-down list.

4. Check Hot standby, then click Next. Follow the prompts to continue the configuration.


Maintenance Tasks

Procedure: Changing the Name of a ComponentYou can change the name of a component in the Network Administration Tree pane by using the associated Configuration tab.For example, you can change the name of a service engine using the following procedure:

1. In the Network Administration Tree pane, choose the service engine from the list.

2. Click the Configuration tab. The Configuration tab page for a service engine displays information about the selected service engine (Figure 74).

Figure 74. Configuration Tab Page for Service Engine

3. In the Name field, enter a name for the service engine. The Save changes button becomes available.

4. Click Save changes. The name of the service engine is changed.


Maintenance Tasks

Procedure: Changing Agent ConfigurationYou can change the configuration of an agent using the following procedure:

1. In the Network Administration Tree pane, choose the agent from the list.

2. Click the Configuration tab. The Agent Configuration tab page displays information about a specific agent. Use this pane to enter or change agent values, access its Properties dialog box or Devices dialog box, and submit those values to the system. Figure 75 is an example of a configuration tab page for an agent.

Figure 75. Agent Configuration Tab Page

Note: You must undeploy all services that depend on the agent before changing the selected agent.

UG_ACTP


Maintenance Tasks

Table 9 describes the agent object components.

Depending on the agent you select, the system also presents buttons to select either an Agent Properties dialog box or a Devices dialog box from this page. For some agents, the system presents buttons for both dialog boxes. If the system presents a dialog box for the agent, complete it before you submit the agent values to the system. (See Agent Properties Dialog Box and Agent Devices Dialog Box below.)

3. Click Submit. The configuration of the agent is changed.

Table 9. Agent Object Pane Components and Functions

Component Function

Category* Indicates the agent category.

Type* Indicates the agent type within the category. *This can vary, depending on the agent.

Assigned to Denotes that the agent is complete but not yet deployed.

State Denotes that the agent is deployed in the BPM system, and you can use the agent in a running service.

Local If selected, agent runs on the current BPM system (local).

Remote If selected, agent runs on another BPM system (remote).

IP Address The IP address of the remote agent.

Subnet Mask The subnet mask of the remote agent.

Gateway The IP gateway the remote agent uses.

Port Port number through which remote agent communicates with network.


Maintenance Tasks

Agent Properties Dialog BoxIf the system presents an Agent Properties dialog box, complete it before you submit the agent values to the system. The Agent Properties dialog box (Figure 76) displays information about the selected agent. Use this box to enter or change values for the agent and submit those values to the system. Properties marked with an asterisk (*) are required.

Figure 76. Sample Agent Properties Dialog Box

Table 10 describes the agent properties.

Table 10. Agent Properties, Definitions, and Examples for HTTP Agent

Property Definition Example

servletAddress Servlet IP address. 10.68.3.124

servletPort Port number associated with the servlet address.

5555

templatePrefix Prefix of the template. http://traveler/tazz/

urlPrefix Prefix of the URL. http://lanai:8080/tazz-1.0.1.5/servlet/RequestHandler


Maintenance Tasks

Agent Devices Dialog BoxIf the system presents an Agent Devices dialog box, complete it before you submit the agent values to the system. The Agent Devices dialog box (Figure 77) displays device information about the selected agent. It lists the devices used by the agent and the name and value that describe each device. Properties marked with an asterisk (*) are required. Use this box to enter or change device information for the agent and submit those values to the system.

Figure 77. Sample Agent Devices Dialog Box

Procedure: PatchingA patch is a small piece of code or data that corrects the original cod or data. You can import patches for rules or binary files. To import patches:

1. Choose Tools --> Patch.

2. Click Binary files or Rules.

3. Browse to the patch file to import. The selected patch is imported and installed.


Maintenance Tasks

Clusters and FailoverThe system offers manual and automatic failover to support system resiliency. Failover is implemented by clustering service engines so that one service engine acts as the standby to another service engine. This section discusses that process. You only cluster Resource Controllers and the Topology Database Server.The system supports two types of resiliency: warm standby and hot standby. There are two major differences between the two schemes. In warm standby, agents and services are deployed, but not started on the standby. Additionally, data-related network interfaces on the standby are configured identically to those on the active, but are left disabled. When a failover event occurs, the standby enables its interfaces, and sends gratuitous ARPs to inform other network equipment of the new IP to MAC address mapping. Once interfaces are enabled, the standby starts deployed agents and services. In hot standby, agents and services are running, but remain idle. The data interfaces are configured with unique IP addresses and are enabled. Requests are forwarded to the active node in the pair by a request director. When a failover event occurs, the director is notified and subsequent requests are forwarded to the standby.

Procedure: Using Broadband Policy Studio to Create a ClusterTo join two service engines together into a cluster, first determine which engine serves as the active engine and which is the standby. Both engines must be running on machines with more than one network interface card (NIC), and they both must be configured to run on the same port. Both Service Engines must not be part of another cluster already. Both Service Engines must be running.


Maintenance Tasks

For example, the two Service Engines in Figure 78 can be clustered together:

Figure 78. Two Service Engines That Can Be Clustered

To create a cluster using the Broadband Policy Studio (BPS):

1. Right-click the engine that you have chosen to be the “active” member of the cluster.

2. From the drop-down menu, choose Create cluster. A software wizard appears.

3. Choose the engine that you have chosen to be the standby engine.

Figure 79. Choosing Standby Service Engine

4. Check Hot standby, then click Next.

SG_SEC


Maintenance Tasks

5. Choose the databases on the active service engine to replicate. Click Next.

Figure 80. Confirming Standby Service Engine

6. Confirm your choice, and click Finish.

Figure 81. Confirming Standby Service Engine

When you click Finish, the software clusters the engines together.


Maintenance Tasks

To visually represent the cluster, the standby engine does not appear independently in the tree list. Instead, the active service engine has a double icon, and the standby service engine appears as the standby in the right pane when the active engine is selected. In addition, the replicated databases also have double icons.

Figure 82. Standby Engine of Active Engine

Interface Hostname FilesWith a warm standby, to prevent the BPM from sending a gratuitous ARP, the hostname.<primary-interface> and hostname.<secondary-interface> files must be removed from /etc (where <primary-interface> and <secondary-interface> denote the names of the appliance's primary and secondary interfaces, respectively).To determine the names of the primary and secondary interfaces, run the "tazzifconfig -a" command. The lines that have a "P" or an "S" under the "r" column denote the primary and secondary interfaces respectively.

SG_SEF


Maintenance Tasks

Example (your output may be different):interface r s current ip configured ip MAC address subnet mask------- - - ------------- ------------ ------------- ----------e1000g0 M U 192.168.111.85 192.168.111.85 0:7:e9:23:e2:3e 255.255.0.0e1000g1 H U 10.0.0.1 10.0.0.1 0:7:e9:23:e2:3f 255.255.255.0e1000g2 P U 10.1.10.35 10.1.10.35 0:4:23:a9:56:82 255.255.255.0e1000g3 S U 172.18.0.3 172.18.0.3 0:4:23:a9:56:83 255.255.255.0

This sample listing shows that e1000g2 is the primary interface and e1000g3 is the secondary interface. Therefore, the /etc/hostname.e1000g2 and /etc/hostname.e1000g3 files must be removed from the system.To do this, enter these commands:

su rootcd /etcrm hostname.<primary-interface> hostname.<secondary-interface>

Procedure: Removing Database from ReplicationIf you right-click one of the databases for a clustered service engine, a drop-down menu appears. From this menu you can remove the database from replication.

Figure 83. Database Menu


Maintenance Tasks

Procedure: Verifying Cluster HealthYou can use the BPS to verify various aspects of the health of a cluster.

Viable ClusterA viable cluster shows both engines in the Running state.

Figure 84. Viable Clusters: Both Running

SG_SEF


Maintenance Tasks

Failed ClusterIf something goes wrong in the cluster, you can view the states of the cluster components in the user interface. The former active service engine appears as Failed.

Figure 85. Failed Cluster

If the active member of the cluster fails, the cluster is dissolved. The former standby service engine is now the active service engine.

Figure 86. Active Cluster Fails: Cluster Dissolved

SG_SECF

SG_SECD


Maintenance Tasks

Procedure: Manually Initiating FailoverYou can also manually initiate a failover of the active to the standby. Right-click the active Service Engine and choose Failover to standby.

Figure 87. Manually Initiating Failover

SA_DC


Maintenance Tasks

The active fails. All of the agents and services are moved to the standby.

Figure 88. Active Cluster Fails: Standby Continues

SG_SECD


Maintenance Tasks

Procedure: Dissolving a ClusterYou can dissolve a cluster manually by right-clicking the active service engine and choosing Dissolve cluster.

Figure 89. Dissolving Cluster Manually

For a warm standby, if you need to uncluster the service engines, you must re-create the host files for the primary and secondary interfaces. As root on all clustered platforms, create the following files:

touch /etc/hostname.e1000g2touch /etc/hostname.e1000g3

FailoverThere are two types of failover: manual and automatic.


Maintenance Tasks

Manual FailoverThe manual failover procedure provides the Broadband Policy Studio user a means of initiating a controlled failover where both the active and standby service engines coordinate the scenario in a synchronized fashion. This synchronized sequence of events allows the active scheduler a time window to complete any current jobs it might be in the middle of executing before the interfaces are shut off on the active and subsequently enabled on the standby service engine.To initiate a manual failover:

1. Right-click the clustered service engine’s icon displayed in the tree control pane of the Network Administration view

2. Choose Failover to standby.

The standby service engine takes over the configured primary and secondary IP addresses. It does this by enabling these interfaces and sending out a gratuitous ARP to force attached hosts to update their respective ARP caches with the new MAC addresses from the standby service engine. The active service engine, in turn, disables its primary and secondary interfaces and changes them over to acquire the old IP addresses that were configured on the former standby service engine, disables those interfaces, and proceeds with a reset and shutdown of the system.

Automatic FailoverThe automatic failover scenario is initiated solely on the standby service engine as a result of the standby detecting that the clustered active service engine has failed to respond to a configurable number of heartbeat requests from the standby service engine. (the default is three consecutive missed heartbeats). This is also referred to as hard failover.

Resolving FailoverAfter a failover event, the former secondary of a clustered pair becomes the primary, and the former primary is considered non-functional. The Director topology database is automatically updated to reflect this change. The Director topology database has two sets of fields for the primary and secondary of a given Resource Controller pair. The fields for the primary do not start with underscores, those for the secondary do. Note also that the system swaps these values when needed, for example, after a failover event. Therefore, the fields without underscores always refer to the currently running primary, not necessarily the system that was originally provisioned as the primary.


Maintenance Tasks

One of the fields for the primary and secondary is "Health" (or "_Health".) This represents the current state of that system with the following values: • 0 means that the system is running and healthy. In the case of the secondary, this

means it is available to become primary, if needed.• -1 means that the system is not healthy. This usually means that it has failed, and

the operator has not yet intervened to correct the situation.• -2 means that the system is in failover transition.• A value greater than 0 means that the system is running and healthy, but that the

interface has failed (for example, a reservation has failed) the number of times represented by the number. After a certain (specifiable) number of failures, a failover will occur.

Procedure: Resolving Failover of Active Resource ControllerIf an active cluster member fails, its standby should become the active cluster member. Perform the following steps to confirm that this has happened, and to add the former active back into the clustered pair, as the new standby system:

1. Make sure that the Director shows that health=0 and _health=-1. This indicates that the standby has taken over, and that the former active is not available for service.

Also, the host and port fields should match the new active (former standby), and the _host and _port fields should match the former active.

2. On the former active, run this command:

start_tazz -reset

3. Rebuild the cluster by following these steps:

a. Using the BPDS, right-click the new active, then choose Create Cluster. b. Select both policy and engine databases for replication, when prompted.

4. On the former active, run this command:

qssh <install>/config/qos_start.config

where <install> is the installation directory.

5. Ensure that the cluster is fully functional and healthy.

6. On the Director, run the following commands to set _health=0, to tell the Director that the former active (now new standby) is available to assume operation, if needed:


Maintenance Tasks

qssh SetHealth <A-RACF IP> <A-RACF port> standby up

where <A-RACF IP> is the IP address of the Resource Controller from the Director topology.tim file, and <A-RACF port> is the port for that Resource Controller.

Procedure: Resolving Failure of Standby Resource ControllerIf a standby cluster member fails, its active remains the active cluster member. Perform the following steps to make sure the Director does not try to failover to the failed standby, and to add the failed standby back into the clustered pair:

1. On the Director, run the following command to set _health=-1, to tell the Director that the standby is not available to assume operation:

qssh SetHealth <A-RACF IP> <A-RACF port> standby down


2. On the standby, run this command:

start_tazz -reset

3. Rebuild the cluster by following these steps:

a. Using the BPDS, right-click the new active, then choose Create Cluster. b. Select both policy and engine databases for replication, when prompted.

4. On the standby, run this command:

qssh <install>/config/qos_start.config

5. Ensure that the cluster is fully functional and healthy.

6. On the Director, run the following command to set _health=0, to tell the Director that the standby is once again available to assume operation, if needed:

qssh SetHealth <A-RACF IP> <A-RACF port> standby up



Maintenance Tasks

Procedure: Resolving Failure of Active TDS TDS failover is initiated either as a manual operation, or by the standby heartbeat daemon if is has problems communicating with the active.Because TDS systems are warm clustered, when a TDS failover occurs, the Directors and Resource Controllers see the new active exactly as the former active (for example, with the same IP address.) Therefore, reset and recluster the former active as the new standby.

Procedure: Resolving Failure of Standby TDSIf a standby TDS system fails, the problem is detected by the active TDS's heartbeat daemon. Reset and recluster the standby TDS with the active.

Failed Node RecoveryRecovering a failed node depends on which node failed and how the failure occurred. Recovery usually involves failed node recovery, action on the current active node, BPS actions, and ramdisk considerations.

Recovering When Active Node FailsAn active node can fail for several reasons, including a BPS-initiated failure, running stop_tazz on the platform, OS shutdown, or power loss.

Procedure: Recovering from BPS-Initiated FailoverTo recover the failed node, connect to the backend and follow these steps:

1. Verify that primary and secondary addressing on the BPM backend is correct by executing this command:

/opt/tazz/bin/tazzifconfig -a

The output of this command looks like this:

interface r s current ip configured ip MAC address subnet mask------- - - ------------ ----------- -------------- ---------e1000g0 M U 192.168.111.85 192.168.111.85 0:7:e9:23:e2:3e 255.255.0.0e1000g1 H U 10.0.0.1 10.0.0.1 0:7:e9:23:e2:3f 255.255.255.0e1000g2 P U 10.1.10.35 10.1.10.35 0:4:23:a9:56:82 255.255.255.0e1000g3 S U 172.18.0.3 172.18.0.3 0:4:23:a9:56:83 255.255.255.0

2. For a warm standby, the primary and secondary addresses should be the addresses of the former standby. If not, execute this command to set the primary address:

/opt/tazz/bin/tazzifconfig -p -c <primary-addr> -pe

Execute this command to set the secondary address:


Maintenance Tasks

/opt/tazz/bin/tazzifconfig -s -c <secondary-addr> -pe

3. Execute this command:

/opt/tazz/bin/start_tazz -reset

When prompted to reset the system and replication, respond yes to both.

The BPM engine is cleaned up. All agents and services are removed. Replication is removed from the database. Node shows as Running in BPS.

For a warm standby, to rebuild cluster using the BPS, follow these steps:

1. Right-click former standby node (now active).

2. Choose Create cluster.

3. Choose both policy and engine databases for replication, when prompted.

The service engines are now a clustered pair.

Figure 90. Reclustering Successful

Procedure: Recovering from stop_tazz -f FailoverTo recover the failed node, connect to the backend and follow these steps:

1. Modify the primary and secondary addressing on the BPM backend to the values of the former standby. Execute these commands:


Maintenance Tasks

/opt/tazz/bin/tazzifconfig -p -c 10.1.10.35 -pe/opt/tazz/bin/tazzifconfig -s -c 172.18.0.3 -pe

2. Verify that the addressing is correct by executing this command:


The output of this command looks like this:interface r s current ip configured ip MAC address subnet mask--------- - - -------------- -------------- ----------------- ----------e1000g0 M U 192.168.11.85 192.168.11.85 0:7:e9:23:e2:3e 255.255.0.0e1000g1 H U 10.0.0.1 10.0.0.1 0:7:e9:23:e2:3f 255.255.255.0e1000g2 P U 10.1.10.35 10.1.10.35 0:4:23:a9:56:82 255.255.255.0e1000g3 S U 172.18.0.3 172.18.0.3 0:4:23:a9:56:83 255.255.255.0

The primary and secondary addresses should be the addresses of the former standby.





For warm standby, to rebuild cluster using the BPS, follow these steps:

1. Right-click the former standby node (now active).


3. Choose the former active node as the new standby.



Maintenance Tasks



Procedure: Recovering from Failover Due to OS-level FailureThis can occur because of reboot, power loss, and other causes.

To recover any failed node, connect to the backend and follow these steps:

1. Upon boot, execute these commands on the failed node in order to plumb and configure the primary and secondary interfaces (the interfaces plumb to the former standby addresses):

Note: The correct way to reboot a Solaris system is to enter the command:shutdown -g0 -i6 -y

The correct way to halt a Solaris system is to enter the command:shutdown -g0 -i5 -y


Maintenance Tasks

% /usr/sbin/ifconfig.tazz-setuid <interface> plumb <ip-address>/<num-mask-bits> broadcast <broadcast-addr>

For example, to configure e1000g2 with an ip-address of 172.1.2.3 with a subnet mask of 255.255.255.0, one would use:

% /usr/sbin/ifconfig.tazz-setuid e1000g2 plumb 172.1.2.3/24 broadcast 172.1.2.255

Run this command for both the primary and secondary interfaces. Finally, to persist IP address changes to the configuration files the tazzifconfig command must be run with the -pe[rsist] option as follows:

% tazzifconfig -p -c <primary-ip-address> -pe% tazzifconfig -s -c <secondary-ip-address> -pe

where primary-ip-address is the former standby IP Primary address, and secondary-ip-address is the former standby IP Secondary address.






3. Issue the following command:

Note: If the primary and secondary interfaces had any associated routes, add them back into the routing table. To check for missing routes, use the command:netstat -rn


Maintenance Tasks



4. Choose the formerly failed node (now Running).

5. If the policy database displays schema unknown, then load the metadata for your application (secureAccessDatabaseGUISupport.tzz). Connect to the policy database on the former failed node. Then choose Tools --> Package --> Install and browse to the file.

For warm standby, to rebuild the cluster using the BPS, follow these steps:

1. Right-click former standby node (now active).





Recovering When Standby Node FailsA standby node can fail for several reasons, including running stop_tazz on the platform, OS shutdown, or power loss.


Maintenance Tasks

Procedure: Recovering from stop_tazz -f FailoverTo recover the failed node, connect to the backend and follow these steps:





2. The primary and secondary addresses should be the addresses of the former standby. If not, execute this command to set the primary address:

/opt/tazz/bin/tazzifconfig -p -c <primary-addr> -pe

Execute this command to set the secondary address:

/opt/tazz/bin/tazzifconfig -s -c <secondary-addr> -pe





4. If using ramdisk, follow these steps (otherwise skip to next procedure):

a. Choose formerly failed node (now Running).

b. If the policy database displays schema unknown, then load the metadata for your application (secureAccessDatabaseGUISupport.tzz). Connect to the policy database on the former failed node. Then choose Tools --> Package --> Install and browse to the file.

5. Follow these steps:

a. Connect to the active node backend.

b. Execute these commands:


Maintenance Tasks

/opt/tazz/bin/databasemanager -clireplic::drop-node policy <ip-address of standby heartbeat>replic::drop-node engine <ip-address of standby heartbeat>

6. For warm standby, to rebuild the cluster using the BPS, follow these steps:

a. Right-click active node.

b. Choose Create cluster.c. Choose both policy and engine databases for replication, when prompted.




Maintenance Tasks

Procedure: Recovering from Failover due to OS-level FailureThis can occur because of reboot, power loss, and other causes.

To recover any failed node, connect to the backend and follow these steps:




2. Upon boot, execute these commands on the failed node to plumb and configure the primary and secondary interfaces (the interfaces plumb to the former standby addresses):

% /usr/sbin/ifconfig.tazz-setuid <interface> plumb <ip-address>/<num-mask-bits> broadcast <broadcast-addr>

For example, to configure e1000g2 with an ip-address of 172.1.2.3 with a subnet mask of 255.255.255.0, use:

% /usr/sbin/ifconfig.tazz-setuid e1000g2 plumb 172.1.2.3/24 broadcast 172.1.2.255

3. Run this command for both the primary and secondary interfaces.

4. To persist IP address changes to the configuration files the tazzifconfig command must be run with the -pe[rsist] option as follows:

Note: The correct way to reboot a Solaris system is to enter the command:shutdown -g0 -i6 -y

The correct way to halt a Solaris system is to enter the command:shutdown -g0 -i5 -y


Maintenance Tasks

% tazzifconfig -p -c <primary-ip-address> -pe% tazzifconfig -s -c <secondary-ip-address> -pe

where primary-ip-address is the former standby IP Primary address, and secondary-ip-address is the former standby IP Secondary address.




interface r s current ip configured ip MAC address subnet mask------- - - ------------ ------------ ------------- ---------e1000g0 M U 192.168.111.85 192.168.111.85 0:7:e9:23:e2:3e 255.255.0.0e1000g1 H U 10.0.0.1 10.0.0.1 0:7:e9:23:e2:3f 255.255.255.0e1000g2 P U 10.1.10.35 10.1.10.35 0:4:23:a9:56:82 255.255.255.0e1000g3 S U 172.18.0.3 172.18.0.3 0:4:23:a9:56:83 255.255.255.0


6. Choose formerly failed node (now Running).

7. If the policy database displays schema unknown, then load the metadata for your application (secureAccessDatabaseGUISupport.tzz). Connect to the policy database on the former failed node. Then choose Tools --> Package --> Install and browse to the file.

8. Follow these steps on the active node:

a. Connect to the active node backend.

b. Execute these commands:

/opt/tazz/bin/databasemanager -clireplic::drop-node policy <ip-address of standby heartbeat>

Note: If the primary and secondary interfaces had any associated routes, add them back into the routing table.

To check for missing routes, use the command:netstat -rn


Maintenance Tasks

replic::drop-node engine <ip-address of standby heartbeat>

9. For warm standby, to rebuild cluster using the BPS, follow these steps:

a. Right-click active node.

b. Choose Create cluster.c. Choose both policy and engine databases for replication, when prompted.



Recovering from a Hard Failure - Power Loss or Power Cable Disconnected

A node may fail because of power loss or disconnection of a power cable.

Procedure: Recovering Policy RepositoriesIn the event of a power outage, reload the BPM software onto the failed node by following the steps below:

1. Verify that the 3310 is mounted correctly by using the df -k command:

df -k


Maintenance Tasks

2. Look for the following:

Filesystem kbytes used avail cap Mounted on/dev/dsk/c2t0d0s2 281352620 653644 277885450 1%

/shared/db3310

3. If the mount point is not present, run an fsck on the 3310 partition and reboot the node.

4. If the mount point is missing, run an fsck on the 3310 partition and answer yes for all questions:

fsck /dev/dsk/c2t0d0s2

5. Log in to the failed node and remove the existing backend by executing these commands:

ps -ef |grep tazz

If any tazzadmin processes are running, run stop_tazz -f.

cd /home/tazzadminrm -rf /opt/tazz

6. Verify that the IP addresses are correct, and that all interfaces are up, by executing this command:

/usr/sbin/ifconfig -a

Note: You may see some or all of the following error messages when executing the rm command, which is normal because the /opt/tazz directory and some of its contents are owned by root and cannot be removed by the tazzadmin user. Please ignore these messages.

rm: Unable to remove directory /opt/tazz: Permission denied

rm: Unable to remove directory /opt/tazz/statistics/logs: File exists

rm: Unable to remove directory /opt/tazz/statistics: File exists


Maintenance Tasks

If the primary and secondary interfaces are missing, add them back in with the following commands:

% /usr/sbin/ifconfig.tazz-setuid <interface> plumb <ip-address>/<num-mask-bits> broadcast<broadcast-addr> [up]

For example, to configure e1000g2 with an IP address of 172.1.2.3 with a subnet mask of 255.255.255.0, one would use:

% /usr/sbin/ifconfig.tazz-setuid e1000g2 plumb 172.1.2.3/24 broadcast 172.1.2.255 up

where 172.1.2.3 is the primary IP address of the standby, and not the floating active primary IP address

Run this command for both the primary and secondary interfaces.

7. Install the backend on the failed BPM. Upgrade the failed node by performing a fresh installation using the new backend install.

8. Load the new backend by entering the following commands:

cd /home/tazzadmin/software/tazz14x/chmod 744 backend-1xx.sh./backend-1xx.sh

9. Take all defaults except for the following:

Install backend in [/home/tazzadmin/software/tazz1405/tazz]: /opt/tazzInstallation type (stand-alone | custom) [stand-alone]: customInstall Service Engine (yes or no) [yes]: yesInstall Domain Controller (yes or no) [yes]: noInstall Application Database (yes or no) [yes]: yesNumber of database connections [20]: 96

10. Create the 3310 links by entering these commands:

rm -rf /shared/db3310/dbcd /opt/tazzmv db /shared/db3310/ln -s /shared/db3310/db /opt/tazz/db

11. Restart the BPM on the node being upgraded, by executing this instruction:


Maintenance Tasks

/opt/tazz/bin/start_tazz -clean

12. Rejoin the domain by performing these steps:

a. Execute this command:

/opt/tazz/bin/controller -cli

b. Execute this command:

djoin 172.17.60.61 10000

where 172.17.60.61 is the IP of the Domain Controller BPM.

c. Exit the controller CLI by executing this command:

quit

d. In the BPS, verify that the red mark on the BPM has cleared.

13. Load the metadata by performing these steps:

a. Connect the BPS to the Domain Controller BPM using the database of the node being upgraded.

b. Choose Tools --> Package --> Install.c. Browse for the metadata file provided, for example,

“secureAccessDatabaseGUISupport.tzz”.

d. Click Open to install the metadata.

In the Network Administration view, under Databases, if the policy database schema still shows unknown for the BPM, right-click the database and choose Refresh.

Figure 95. Refresh Command

14. Log in to the now active policy repository and execute these commands:

/opt/tazz/bin/databasemanager -clireplic::drop-node policy replic::drop-node engine


Maintenance Tasks

Verify that replication has been dropped by executing these commands:

ci policyci engine

No subscription information should be present.

15. Recluster the nodes by performing these steps:

a. Use the BPS logged in to the database of the active node, and SSH connections to the two nodes.

b. Locate the active node. The active node has agents and services.

c. Right-click the active node.

d. Choose Create cluster and choose the standby node.


UG_TPCSE


Maintenance Tasks

e. Check both the Engine and the Policy for replication. Click Next, then click Finish. Wait for the replication to finish. This is done by verifying that the policy subscription on the Active and Standby are set to true, by executing these commands:

/opt/tazz/bin/databasemanager -clici policyquit

Cluster subscriptions are of the form:

[Subscription:set=1,provider=3,receiver=4,forward=false, active=true]

16. Verify a user.

a. Configure and activate a user session. (A RADIUS Start is sent and processed for the user.)

b. Send a top up.

17. Verify by checking in the BPS that an active session exists on the active Session Controller BPM, and that the correct usage exists and matches on the active Session Controller BPM and Policy Repository BPM.

Procedure: Recovering Session Controller BPMs1. Log in to the failed node and remove the existing backend by executing these

commands:

ps -ef |grep tazz (Verify no tazzadmin processes running. If there are, run a stop_tazz -f.)cd /home/tazzadmin

2. Delete the ramdisk, by executing these commands:

cd /opt/tazz/bin./mkramdisk -d -name policy

3. Verify that the IP addresses are correct, and that all interfaces are up, by executing this command:

/usr/sbin/ifconfig -a

If the primary and secondary interfaces are missing, add them back with the following commands:


Maintenance Tasks

% /usr/sbin/ifconfig.tazz-setuid <interface> plumb <ip-address>/<num-mask-bits> broadcast <broadcast-addr> [up]

For example, to configure e1000g2 with an ip-address of 172.1.2.3 with a subnet mask of 255.255.255.0, one would use:

% /usr/sbin/ifconfig.tazz-setuid e1000g2 plumb 172.1.2.3/24 broadcast 172.1.2.255 up

where 172.1.2.3 is the primary IP address of the standby, and not the floating active primary IP address

Run this command for both the primary and secondary interfaces.

4. Remove the existing BPM by executing these commands:

cd /home/tazzadminrm -rf /opt/tazz

5. Install the backend on the failed BPM. Upgrade the failed node by performing a fresh installation using the new backend install.

6. Load the new backend by entering the following commands:

cd /home/tazzadmin/software/tazz14x/chmod 744 backend-1xx.sh./backend-1xx.sh -ramdisk

7. Take all defaults except for the following:

Install backend in [/home/tazzadmin/software/tazz1405/tazz]: /opt/tazz

Note: You may see some or all of the following error messages when executing the rm command, which is normal because the /opt/tazz directory and some of its contents are owned by root and cannot be removed by the tazzadmin user. Please ignore these messages.

rm: Unable to remove directory /opt/tazz: Permission denied


Maintenance Tasks

Installation type (stand-alone | custom) [stand-alone]: customInstall Service Engine (yes or no) [yes]: yesInstall Domain Controller (yes or no) [yes]: noInstall Application Database (yes or no) [yes]: yesNumber of database connections [20]: 48Ram disk name [policy]: policyRam disk size in mb [256]: 2048

8. Restart BPM on the node being upgraded, by executing this instruction:

/opt/tazz/bin/start-tazz -clean

9. Rejoin the domain by performing these steps:

a. Execute this command:

/opt/tazz/bin/controller -cli

b. Execute this command:

djoin 172.17.60.61 10000

where 172.17.60.61 is the IP of the Domain Controller BPM.

c. Exit the controller CLI by executing this command:

quit

d. In the BPS, verify that the red mark on the BPM has cleared.

10. Load the metadata by performing these steps:

a. Connect the BPS to the Domain Controller BPM using the database of the node being upgraded.

b. Choose Tools --> Package --> Install.c. Browse for the metadata file provided, for example,

“secureAccessDatabaseGUISupport.tzz”.

d. Click Open to install the metadata.


Maintenance Tasks

In the Network Administration view, under Databases, if the policy database schema still shows unknown for the BPM, right-click the database and choose Refresh.

Figure 97. Refresh Command

11. Recluster the nodes by performing these steps:

a. Use the BPS logged in to the database of the active node, and SSH connections to the two nodes.

b. Locate the active node. The active node has agents and services.

c. Right-click the active node. Choose Create cluster and choose the standby node.


UG_TPCSE


Maintenance Tasks

d. Check both the Engine and the Policy for replication. Click Next, then click Finish. Wait for the replication to finish. This is done by verifying that the policy subscription on the Active and Standby are set to true, by executing these commands:

/opt/tazz/bin/databasemanager -clici policyquit

Cluster subscriptions are of the form:

[Subscription:set=1,provider=3,receiver=4,forward=false,active=true]

12. Verify a user. Configure and activate a user session (a RADIUS Start is sent and processed for the user) and send a top up.

13. Verify by checking in the BPS that an active session exists on the active Session Controller BPM, and that the correct usage exists and matches on the active Session Controller BPM and Policy Repository BPM.

Procedure: Setting Up the Standby Domain Controller BPM1. Log in to the current Domain Controller BPM and stop the BPM system by

executing this command:

domaincontroller -stop -force

2. Tar the BPM database by executing these commands:

cd /opt/tazz/dbtar cvf tazz-db.tar tazz

3. Edit the active Domain Controller BPM's resources to increase the se.state-notification-interval. By default, this is set to 60 seconds. You need to update it to 120 seconds.

cd /opt/tazz/config/com/tazz/resourcesvi package.properties

4. Change se.state-notification-interval to 120.

5. Restart the active Domain Controller BPM by executing this command:

domaincontroller -start

6. Log in to the standby Domain Controller BPM through the primary IP.


Maintenance Tasks

7. Install the BPM backend on the standby as a Domain Controller BPM. DO NOT start the domain controller on the standby: leave it down.

8. Modify the resources file on the standby Domain Controller BPM by executing these commands:

cd /opt/tazz/config/com/tazz/resourcesvi package.properties

9. Change se.state-notification-interval to 120.

10. Using FTP, copy the tazz-db.tar file from the active Domain Controller BPM to the /opt/tazz directory on the standby Domain Controller BPM.

11. Replace the BPM database on the standby Domain Controller BPM with the image taken from the active Domain Controller BPM, by executing these commands:

cd /opt/tazz/dbrm -rf tazztar xvf /opt/tazz/tazz-db.tarchmod -R 700 tazz

12. Configure the failover system's management IP with the same IP as the active Domain Controller BPM. Make sure that no cable is connected to the management interface.

/usr/sbin/ifconfig e1000g0 98.98.0.141 netmask 255.255.255.0

13. Edit /opt/tazz/bin/.bin/tazzwrapper to update the management IP environment variable, using this command:

vi /opt/tazz/bin/.bin/tazzwrapper

Search for TAZZ_MANAGEMENT_IP and change it to 98.98.0.141.

14. Edit /opt/tazz/config/com/tazz/resources/package.properties to change the se.management-ip setting to the IP address used in step 13:

vi /opt/tazz/bin/.bin/tazzwrapper

Search for se.management-ip and change it to 98.98.0.141.


Maintenance Tasks

The standby Domain Controller BPM is now configured identically to active Domain Controller BPM. To test this, unplug the management cable of the active, then start the BPM on the standby.

What’s Next?In addition to maintenance tasks, problems can arise. Chapter 5, Troubleshooting Tasks, suggests how to handle certain problems.


Troubleshooting Tasks

5


OverviewOccasionally issues may arise. There are several ways of identifying and solving problems using the Broadband Policy Studio.

Logging inIf you cannot log in to the BPS, check to make sure that you have the correct address and port for the Domain Controller BPM and the application database, and that you are using the correct username and password. If all those items are correct, the Domain Controller BPM or application database may not be running, or there may be an interruption in the connection to them.

System InformationSome issues are evidence of a more widespread problem. You can examine several aspects of system information using the BPS.

Network Administration Tree PaneHere are some of the components you can check using the tree pane of the Network Administration view.



Service Engine StatusExamining the service engine status can help resolve questions such as:• Are there any issues with service engines? • Do clusters of service engines still have their standby? • Has there been a failover?

Open the Service Engine folder (Figure 99). A list of Service Engines appears. If there is a problem with a service engine, a red X symbol appears over the Service Engine icon. If this was a primary Service Engine, this indicates that a failover has occurred. The problem may mean that the platform is not running, that the BPM system is not running, or that the platform is not reachable on the network.

Figure 99. Unreachable Service Engine in Network Administration View

A blue question-mark symbol on a Service Engine icon indicates a new Service Engine that has not yet been activated.You can tell if a Service Engine is part of a cluster by choosing that Service Engine and clicking the Configuration tab. Clustered Service Engines have a standby Service Engine listed. To dissolve the cluster, right-click the Service Engine, then choose Dissolve cluster.You can see which databases a search engine has by choosing the search engine and clicking the Configuration tab. The databases appear on the Configuration tab, as in Figure 99.

SA_SEF



Agent StatusExamining the agent status can help resolve questions such as:• Are all agents started? • Are agents deployed? • Are agents running? • Are agents configured properly?

Open the Agents folder under each Service Engine folder (Figure 100). A list of agents appears. An agent with a blue icon is not deployed. A blue icon with a star is a new agent. An agent with an X symbol on its blue icon is Invalid. Configure it correctly. An agent with a green icon is running. An agent with a triangle symbol on a green icon is Deployed.

Figure 100. Agent Status in Network Administration View



You can obtain statistics on agents. Click the agent, then click the Statistics tab. Available statistics on that agent appear. A list of statistics is in the Statistics addendum to the Operations Guide. Some of the more important statistics for troubleshooting purposes include:

Service StatusExamining the status of services can help resolve questions such as:• Are all services started? • Are services deployed? • Are services running? • Are services configured properly?

Open the Services folder under each Service Engine folder. A list of services appears. A service with a blue icon is new and you must configure it. A service with a green icon and a triangle is Deployed.

Table 11. Sample Agent Statistics

Statistic Detail

agent-restarts Number of agent restarts.

agent-starts Number of agent starts.

dispatch-failed Number of messages switch failed to dispatch. Does not include message-failed.

message-failed Total number of messages processed unsuccessfully.

message-failed-percent Percentage of messages processed unsuccessfully.

switch-restarts Number of switch restarts.



Log PaneThe Log pane (Figure 101) presents informational and error messages. This information can be useful for reviewing operations and for investigating problems. For example, the log pane indicates changes to agent state, as well as processes that have stopped or started.

Figure 101. Sample Log Pane Content

The Log pane only presents BPM log messages that have occurred since the BPS began running. Thus, it is a good idea to keep the BPS running continuously.

Isolating the ProblemThe first step in troubleshooting is to isolate the problem. Before attempting to identify a specific cause, try to define concisely what is happening. The following questions can help you determine the scope of the problem:• What is the symptom?• Is the problem isolated to one service type or does it affect many types of service?• When did the problem start?• Has the configuration of the BPM been changed?• Has any hardware been replaced or upgraded?• Has the configuration, software, or hardware of network devices changed?

Whether or not you are able to pinpoint the trouble spot, review the general troubleshooting steps outlined in this chapter.

UG_6_SLPC



Investigating Hardware IssuesHardware may be the problem. A necessary hardware unit may be powered off, configured incorrectly, connected incorrectly, or malfunctioning. The hardware setup is specific to your arrangement, so no specific instructions are given here.Types of hardware to investigate include:• PCs, Sun devices, and other computer platforms• Modems• Broadband Remote Access Servers (BRAS)• Routers• Other network hardware

To investigate hardware issues, one or more of the following steps may be necessary:• Visual examination of on/off switches• Visual examination of indicator lights• Internal diagnostic tests• External diagnostic tests• Hardware utilities

Perform these tasks according to the directions of your hardware vendor.

Investigating Software IssuesSoftware other than the BPM may be responsible for the problem. Software may be installed improperly, configured incorrectly, failing to interface with other software, or malfunctioning. As with hardware, the software environment is specific to your arrangement.Types of software to investigate include:• Operating systems• Support software, such as security, monitoring, or maintenance software• Network software

To investigate software issues, one or more of the following steps may be necessary:• Ensuring that software is running• Diagnostic tests• Checking interfaces



Troubleshooting ConsiderationsAfter examining all the available sources of BPM information, you probably have a good idea of the source of the issue and how best to solve it. Here are some further considerations when investigating problems.

Is the BPM Running?1. If the BPM is not running, this may affect in many different ways. One way to

determine if the BPM is running is to try to log in to the BPM using the BPS.

2. If you can successfully log in to the BPM, that means that the BPM is running. If you cannot successfully log in to the BPM, the BPM may not be running. You may need to start the BPM. However, it is also possible that the BPM is running, but the BPS cannot reach the BPM. This may be due to network problems between the two, or to incorrect login parameters.

Is the Service Engine Running?If a service engine is not running, none of its associated services are running. The BPS indicates whether a service engine is running or not.

Are Services and Agents Deployed?If necessary services and agents are not deployed, this may affect in many different ways. The BPS indicates whether services and agents are deployed.

When Did Problem Occur?The timing of an issue is a significant indication to its cause. What was happening as the problem occurred? Were any component configurations changing? Identifying associated activities and events can help resolve an issue.


Appendix A - Glossary


This appendix contains abbreviations, acronyms, terms, and their definitions.

Table 12. Terms and Definitions

Term Definition

Numeric

3GPP Third Generation Partners Project.

A

Accounting Log Function

ALF.

Active In a pair of BPMs, the BPM that actively processes requests.

ACF Admission Control Function.

AE Application Environment.

AF Application Function.

Agent An internal BPM component that interacts with a device. The user creates the agent and configures it to interact with a specific device by indicating the device type, IP address, and port number. The user then assigns the agent to perform service functions.

Agent Configuration

Agent information that comprises a specific agent type instance. For example, a RADIUS agent configuration contains appropriate IP address, port, and shared secret values for a RADIUS agent type.

Agent Function See Function.

Agent Instance A running instance of an agent type.

Agent Package Software that allows agents to interact with a particular device type. For example, a RADIUS agent package contains software that allows the BPM user to create agents that interact with specific RADIUS devices.

Agent Type The agent type describes a particular type of agent that you can load onto the system. You choose the agent type when you create the agent instance.

Version 1.5 Cisco Broadband Policy Manager Operations Guide 147 of 168


Alarm Notification Function

ANF.

ALF Accounting Log Function.

ANF Alarm Notification Function.

API Application Program Interface.

Application A service that maps business models and operational procedures directly into IP services, executable by their customers, for example, video on demand or automatic backup. See also Service.

Application Program Interface

API.

Application Service Provider

ASP.

ASP Application Service Provider.

Asynchronous Transfer Mode

ATM.

ATM Asynchronous Transfer Mode.

Attribute In the BPDS Object manager tool, a simple type with a default value. An object can have several attributes.

B

Backend Software that runs on the BPM. It comprises the controller, engine, agent host, activation daemon, and scheduler processes; synonymous with BPM.

BGP Border Gateway Protocol.

Border Gateway Protocol

BGP. An exterior gateway routing protocol that enables groups of routers to share routing information to establish efficient, loop-free routes. BGP is commonly used within and between Internet Service Providers (ISPs).

BPDS Broadband Policy Design Studio.

BPS Broadband Policy Studio.

BRAS Broadband Remote Access Server (10K device).

Table 12. Terms and Definitions (continued)

Term Definition

148 of 168 Cisco Broadband Policy Manager Operations Guide Version 1.5


Broadband Policy Design Studio

BPDS.

Broadband Policy Manager

BPM.

Broadband Policy Studio

BPS.

Broadband IP Services Module

BSM.

Broadband Remote Access Server

BRAS (10K device).

BSM Broadband IP Services Module.

C

CAC Capacity Admission Control.

Capacity Admission Control

CAC.

CTF Context Timer Function.

Class of Service CoS. A traffic prioritization scheme that enables more predictable traffic delivery, based on application requirements.

Classless Inter-Domain Routing

CIDR.

CIDR Classless Inter-Domain Routing, an IP addressing scheme. CIDR addresses reduce the size of routing tables and make more IP addresses available within organizations. CIDR is also called supernetting.

Cisco Network Registrar

CNR.

Client Generic term that denotes the BPM BPDS application.

CNR Cisco Network Registrar.

CoS Class of Service.


Term Definition



CPE Customer Premises Equipment.

CLI command line interface.

Cluster A pair of cooperating and redundant BPMs.

Component An object comprising data and code. A component provides a well-specified set of publicly available services. All devices, services, and applications on a network are components.

Configuration Information necessary to construct an instance of a type (agent, service).

Context Timer Function

CTF.

Controller A software element that runs on the BPM and controls various elements of the backend. Usually only one controller exists per backend; therefore, from the BPDS perspective, the controller is the backend.

CTF Context Timer Function.

Customer Premises Equipment

CPE.

D

Deep Packet Inspection Protocol

DPI.

Device Any piece of software or hardware connected to a network. RADIUS servers, routers, billing systems, accounting systems, and video servers are devices. An agent communicates with a device.

Device Rule A generic task that can be applied to a device that supports the device rule functionality to carry out a network action. Device rules can retrieve information from connected devices. See also Device Type and Policy Rule.

Device Type A classification of actual devices, based on device attributes, including vendor, model, hardware version, and software version. See also Device Rule.

Digital Subscriber Line

DSL.


Term Definition



Domain One or more cooperating BPM systems managed by a single domain repository.

Domain Controller

The software that stores and manages agents, agent types, agent instances, service types, services instances packages, service engines, policy engines, and clusters; also known as the Cisco database.

Domain Data Data maintained about the elements in a domain; for example, controller host and port configuration, database host and port information, agent and service configuration and deployment information.

Domain Repository

The master database that contains configuration information for each domain element.

DPI Deep Packet Inspection Protocol.

DSL Digital Subscriber Line.

DSLAM Digital Subscriber Line Access Multiplexer.

E

Element An object with the BPM: Cisco package; agent configuration; service instance; shared object.

Enumeration In the BPDS Object manager tool, enumeration is contained within a simple type.

Ethernet to the Home

ETTH.

ETSI European Telecommunications Standards Institute.

ETTH Ethernet to the Home.

F

Fiber to the Home

FTTH.

FTTH Fiber to the Home.

Field Replaceable Unit

FRU. An FRU represents an element (e.g., entire system, BPDS client software, agent) within the BPM system that can have a version associated with it. A FRU is a subset of an element.

Flow The movement of data or control between agents. It is a collection of one or more operators and zero or more routes. The designer uses flows to define services and applications.


Term Definition



FRU Field Replaceable Unit.

Function The element that performs an operation, based on inputs and returns the results of the operation via its outputs. The user drags and drops a function into a flow in the BPDS. An agent, which interacts with a device, performs the actual operation.

G

Gateway GW.

GUI Graphical User Interface (BPDS).

Graphical User Interface

GUI (BPDS).

GW Gateway.

H

Head Version The latest version of an element.

HGW Home Gateway.

Hot Backup A backup system, identical in configuration to the primary BPM system. The hot backup is ready to resume request execution immediately if the primary BPM system fails. See Primary BPM, Secondary BPM.

I

ILC Appium SOAP load balancer.

Implementation An instruction set for executing a specification.

Install Rule

Instance An executing type (agent, service), created from a specification, implementation, and configuration. An agent instance is a specific implementation of that agent type.

Integrated Services Digital Network

ISDN.

Interface A collection of functions.

Internet Services Gateway

ISG.


Term Definition



IP address The address that identifies a computer. The IP address format is a 32-bit numeric address written as four numbers (0 to 255) separated by periods.

ISDN Integrated Services Digital Network.

ISG Internet Services Gateway.

ISP Internet Service Provider.

J

JDBCTM Java Database Connectivity (TM of Sun Microsystems; not an acronym).

L

LAN Local Area Network.

L2TP Layer Two (2) Tunneling Protocol.

LLU Local Loop Unbundling.

Local Area Network

LAN.

Local Loop Unbundling

LLU.

M

Management Protocol

A set of protocols for managing devices and networks, for example SNMP, SSH.

Master In a pair of BPMs, the BPM that actively processes requests. Also known as the primary BPM.

Media Gateway MGW.

Metadata In the BPDS Object Manager tool, the data structure. Cisco customers can import metadata to invoke a structure for their database.

MPLS Multiprotocol Label Switching.

MPLS-TE MPLS Traffic Engineering.

MSAN Multi-Services Access Network.

Multi-Services Access Network

MSAN.


Term Definition



Multiprotocol Label Switching

An IETF initiative that integrates Layer 2 information about network links (bandwidth, latency, utilization) into Layer 3 (IP) within a particular autonomous system or ISP. It simplifies and improves IP-packet exchange and gives network operators the flexibility to divert and route traffic around link failures, congestion, and bottlenecks.

N

N + 1 Redundancy

The ability for service engines to use one service engine as a backup.

NAF Network Adaptation Function.

NAS Network Attached Storage.

NASS Network Attachment Subsystem.

NAV The Network Admin view of the BPM system.

Network Loosely coupled set of components.

Network Adaptation Function

NAF.

Network Attached Storage

NAS.

Network Attachment Subsystem

NASS.

Network Device Library Entry

An entry that properly configures a network device for applying a network policy.

Network Event Contained within a profile, a set of install and uninstall rules performed in sequence.

Network Policy A device rule entry, where the device rule contains commands to configure a network device to apply a network policy. See also Device Rule, Policy Rule.

Network Provisioner

A Cisco system on the wholesale side of a wholesale/retail network.

Next Generation Networks

NGN.

NGN Next Generation Networks.


Term Definition



NP Network Provider.

O

Object An agent, controller, function, service, switch, or service within the BPM system.

Object Dependency

An exact object type, for example a Cisco 2500 router agent, that a service depends on. The user adds the object type to the dependency list of the service. All Interfaces supported by the object type are then available for use with the service.

Object Type In the BPDS Object manager tool, object type is defined with attributes. It can own contain, and associate with other object types.

OC Orchestration Controller. That portion of the BPM system that controls processes such as username and password authentication.

Operation and Support Systems

OSS.

Operator A representation of actions to be undertaken on a system networked to a BPM system.

Orchestration Controller

OC. See Domain Controller.

Orchestration Network

The process for handling service calls over a network. It defines the flow of control and information between work units.

OSS Operation and Support Systems.

P

Pad A collection of pins on an operator. This appears as a box along the edge of an operator.

Path Computation Function

PCF.

PCF Path Computation Function.

PCR Peak Cell Rate.

PDF Policy Decision Function

PDP Policy Decision Point.


Term Definition



PE Policy Engine. The software that stores and manages user profile information, subscriber access records, policy rules; also known as the policy database.

PE Provider Edge (router).

Peak Cell Rate PCR.

PEP Policy Enforcement Point.

PF Pool Function

Pin An input or output from an operator. The pin serves as a route endpoint and holds a single input or output value. For example, an operator that needs a username and password as input has two input pins; one for the username; the other, the password.

PM Policy Manager.

PPP Point-to-Point Protocol.

PPPoA Point-to-Point Protocol Over ATM.

Point-to-Point Termination Aggregation

PTA.

Policy A flow comprising a rule or set of rules that take a specific action provided by an ISP for its users. For example, a policy for subscriber access directs how the system identifies a user via user id, access type, and log in location. A policy performs an operation, based on input and returns the results of its action as output.

Policy Database The database of policy objects that services access to make policy decisions.

PDF Policy Decision Function.

PDP Policy Decision Point.

Policy Enforcement Point

PEP.

Policy Engine PE. The software that stores and manages user profile information, subscriber access records, policy rules; also known as the policy database.

Policy Function Policy rules encapsulated in a TCL agent execute function.

Pool Function PF.


Term Definition



PPP Point-to-Point Protocol.

PPPoA Point-to-Point Protocol Over Asynchronous Transfer Mode.

PQ Priority Queue.

PR Policy Repository.

Primary BPM In a pair of BPMs, the primary BPM is processing requests. If the primary fails, the secondary becomes the primary.

Priority Queue PQ.

Profile A sequence of network events involved in creating and taking down a network session for a subscriber.

Property The parameter or characteristic of an agent or device.

Provider Edge PE.

PSTN Public Switched Telephone Network.

PTA Point-to-Point Termination Aggregation.

Public Switched Telephone Network

PSTN.

Q

QoS Quality of Service.

Quality of Service

QoS.

R

RACS Resource and Admission Control Subsystem.

RADIUS Remote Authentication Dial-In User Service.

RC Resource Controller.

RCF Response Cache Function.

Remote Authentication Dial-in User Service

RADIUS. A client/server protocol enabling remote access server communication with a central server to authenticate dial-in users and authorize their access to the requested system or service. RADIUS allows a company to maintain user profiles in a central database. It provides better security, allowing a company to set up a policy that can be applied at a single administered network point.


Term Definition



Remote Method Invocation

(RMI).

Residential Gateway

RG.

Resource and Admission Control Subsystem

RACS.

Resource Controller

RC.

Response Cache Function

RCF.

Retail The Service Provider side of a network.

RG Residential Gateway.

RMI Remote Method Invocation.

Role-based Dependency

A dependency in which a user indicates that multiple service elements support the same interface. The user defines different roles and assigns the required service interfaces to each. The different roles are added to the dependency list for the service and operators are clearly marked to indicate their assigned role.

Route A path between operators.

RS Remote Server.

Rule Criteria applied to the objects and methods of a business system to determine how objects and methods are used by, or for, a given system user. A flow comprises a rule or set of rules. Rules prescribe terms and conditions for a specific action provided by an ISP for its end users. One rule can call another rule.

S

SAF Session Awareness Function.

SAV The Service Admin view of the BPM BPDS.

Schema A set of rules and syntax for storing data.

SDP Session Description Protocol

SDV The Service Design view of the BPM BPDS.

SCR Sustained Cell Rate.


Term Definition



SE Service Engine.

Secondary BPM In a pair of BPMs, the secondary BPM does not process requests. Instead, it monitors the health of the primary to assess its ability to process requests. If the primary is not viable, the secondary becomes the primary.

Service An application that maps business models and operational procedures directly into IP services, executable by their customers. A service comprises objects (agent, controller, function, switch, or other service).

Service Configuration

The information needed to construct a service. The service configuration specifies agent configurations for each function in the service type. The BPM user creates the service configuration.

Service Dependency

The user-defined dependencies of a service. The user builds a service by defining data-flows that use operators from multiple objects, including agents and other services.

Service Engine SE. The software that runs services; also known as the backend.

Service Interface Dependency

If a service uses a particular service interface, but does not require that a specific object provide the service interface, the user can add the service interface as a dependency. The object that provides the interface is determined later.

Service Instance

The running of a service type created by the end user.

Service Palette The agent types available to a service.

Service Profile A collection of services and information about service execution.

Service Provisioner

SP.

Service Type The definition of what agent types are required for a service; the defined flow of data between functions of agent types. The end user or BPM staff creates the service type.

Servlet An applet that runs on a server. Usually refers to a Java applet that runs within a Web server environment. Analogous to a Java applet that runs within a Web browser environment.

Session Aggregation Access Device


Term Definition



Session Aggregation Access Port

Session Awareness Function

SAF.

Session Information Model

SIM.

Session Initiation Protocol

SIP.

Set Top Box STB.

SF Statistics Function

Shared Secret An authentication string that ensures security between devices. KERBEROS is an instance of a shared-secret authentication protocol.

SIF Signaling Interface Function

Signaling Interface Function

SIG.

SIM Session Information Model.

Simple Type In the BPDS Object manager tool, a simple type is similar to data type, except it can express with enumerations.

Simple Network Management Protocol

SNMP. An IETF protocol by which networked devices can be periodically polled for information as part of a network management system.

SIP Session Initiation Protocol

SLA Service Level Agreement.

SNMP Simple Network Management Protocol.

SOAP Simple Object Access Protocol.

SP Service Provider.

SPACE-P Space Provisioning.


Term Definition



Service-based Policy Decision Function

SPDF.

Specification A type definition that includes interface definitions, configuration schemas, and binding information.

SQL Structured Query Language.

Statistics Function

SF.

STB Set Top Box

Structured Query Language

SQL.

Subscriber A customer of a business that provides a wide variety of online services, including e-mail, stock quotes, news, and online forums.

Subscriber Profile

A table entry containing information, such as authentication, authorization, and location on a specific subscriber.

Super Operator A reusable flow that other flows can call. To the other flows, the super operator appears as an operator that they can call and insert on any route.

Sustained Cell Rate

SCR.

Switch A device that filters and forwards packets between LAN segments. Switches operate at the data link layer and the network layer of the OSI Reference Model.

T

TAF Topology Awareness Function

Telecomm and Internet Converged Services and Protocols for Advanced Networking

TISPAN.

TER Transaction Event Record.


Term Definition



Third Generation Partners Project

3GPP.

TIM Topology Information Model.

TISPAN Telecomm and Internet Converged Services and Protocols for Advanced Networking.

TM Traffic Management (TM).

Topology Awareness Function

TAF.

Topology Information Model

TIM.

Topology Storage Function

TSF.

TOS Type of Service.

Traffic Management

TM.

TRPC Transaction Remote Procedure Call.

TSF Topology Storage Function

Type A BPM component group that has a unique specification. It may have an implementation, and it may have one or more configurations and instances.

U

UAF User Accounting Function.

UD/SC User Database / Subscriber Control

UML Unified Modeling Language. UML is the industry standard notation for representing software architecture and design models.

Unified Modeling Language

UML.


Term Definition



User Accounting Function

UAF.

User Database / Subscriber Control

UD/SC.

V

VC Virtual Circuit.

VCI Virtual Circuit Identifier

Virtual Circuit Identifier

VCI.

Virtual MAC vMAC.

vMAC Virtual MAC.

BPDS The graphical user interface administering the Cisco BPM. The application for creating and deploying services.

Virtual LAN VLAN.

Virtual Path Identifier

VPI.

VLAN Virtual LAN. A network of computers that behave as if they are connected to the same wire even though they may be physically located on different segments of a LAN.

VMAC

Voice-over-IP VoIP. Voice delivered using the Internet Protocol.

VoIP Voice-over-IP.

VP Virtual Path.

VPI Virtual Path Identifier.

VPN Virtual Private Network.

VSA Vendor-specific attributes.

Vendor-specific Attributes

VSA.

W

WDSL Wireless Digital Subscriber Line.


Term Definition



Workspace The BPDS area where the designer visually programs services.

Wholesale The Network Provider side of a network.

WSA Web Service Adaptor.


Term Definition


Index

IndexAabbreviations 147accounting functions 82acronyms 147active service engine 104, 105, 107, 110, 111, 112,

114agent configuration 28, 100agent devices 103agent properties 102agent statistics 35agent status 141application database 18, 23Author 31, 34automatic failover 104, 114

Bbackup 73bar

Status 47BPDS client 21BPS

uses 13

Cchange connection to database 27change password 69cluster 104, 105, 106, 107, 109, 110, 112, 113

dissolving 110, 113clustering 104command line interface 1configuration 152

agent 28, 100configuring standby engine 98controller

domain 18, 23conventions

iconic xiiitext xiiused in guide xii

Copy configuration 73creating roles 52creating users 60

Ddatabase

application 18, 23change connection 27refresh 27remove from replication 27, 108

databases 27, 140definitions 102, 147deleting role 59deleting user 70deny permission 54, 64, 68dependencies 31dependencies (rules) 34dependents (rules) 34deployed 145deploying service 93Director 2, 3, 10, 11, 12, 88dissolving cluster 110, 113domain controller 18, 23, 151domains 51


Index168

Ee-mail address 61engine

standby 98errors 45, 143export 73exporting RBAC data 71

Ffailover 111, 113, 114, 140

automatic 104, 114hard 114manual 104, 111, 113, 114

fatal 45

Gglossary 147grant permission 54, 64, 68guide

organization of xv

Hhard failover 114heartbeat 114

Iimplementation 152import 73importing RBAC data 72Index 165ISP 153

Llog file 45

Log in screen 19, 24log messages 45Log pane 45, 143login

system 18, 19, 23, 24, 73, 85, 138

Mmanual failover 104, 111, 113, 114messages 45metadata 73MPLS 153, 154Multiprotocol Label Switching (MPLS) 153, 154

Nname 31, 34name, role 55name, user 61network 154network BPM host 139network BPM port 139network BPM URL 139new role 52new role window 53new user 60new user window 61

Oobject 155

Ppane

Log 45, 143parameters 28, 31parameters (policy function) 31


Index

parameters (rule) 34password 18, 19, 23, 24password, change 69patch 103Patching 103path computation function 5PCF 5permission, deny 54, 64, 68permission, grant 54, 64, 68permissions 58policy function 28, 29, 30Presence Director 10problems 143procedures

installing the BPDS 21logging into the BPM system 19, 24

protocolsMPLS 153, 154Multiprotocol Label Switching (MPLS) 153, 154RADIUS 147, 157Remote Access Dial-In Service (RADIUS) 147,

157Remote Method Invocation (RMI) 158RMI 158Simple Network Management Protocol (SNMP)

153, 160SNMP 153, 160TRPC 162

RRADIUS 147, 157

agent 147RBAC 48RBAC Administration 50, 51RBAC data, exporting 71RBAC data, importing 72RBAC, starting 50

refresh 27refresh database 27Remote Access Dial-In Service (RADIUS) 147,

157Remote Authentication Dial-In User Service

(RADIUS) 157Remote Method Invocation (RMI) 158remove database from replication 27, 108renaming 99replication

remove database 27, 108repository BPM host 139repository BPM port 139repository BPM URL 139Resource Controller 2, 4, 10, 11, 12, 90restore 73RMI 158role assignments 63, 67role name 55role, deleting 59role, new 52role-based access control 48Roles 52roles 51, 52roles, creating 52Rule folder 32rules 31, 32running 145

Sscreen

Log in 19, 24script 31, 34service

configuration 159


Index168

deploying 93type 159undeploying 95

service BPM host 139service BPM port 139service BPM URL 139service engine 140

active 104, 105, 107, 110, 111, 112, 114standby 104, 105, 106, 107, 111, 112, 113, 114

session information 80severity 46shutting down BPM 14Simple Network Management Protocol (SNMP)

153, 160SNMP 153, 160source rule 28, 31source script 28, 31standby 140standby engine

configuring 98standby service engine 97, 104, 105, 106, 107, 111,

112, 113, 114starting BPM 14statistics 36status 26Status bar 47stopping BPM 14subnet mask 101symptom 143system

login 18, 19, 23, 24, 73, 85, 138

TTAF 4TCP port 18, 23terms 147

text conventions xiitopology awareness function 4topology database 10, 12topology store function 5Transaction Remote Procedure Call (TRPC) 162troubleshooting 143, 145TRPC (Transaction Remote Procedure Call) 162TSF 5

Uuncluster 113undeploying service 95user assignments 57user name 18, 19, 23, 24, 61user, deleting 70user, new 60users 51, 59, 60users, creating 60

VVC information 78VP information 79


Cisco Broadband Policy Manager Operations Guide, Release 1.5 · Broadband Policy Manager (BPM). It discusses the EAC applications and their position in the BPM architecture, BPM and

Documents