Cisco Carrier Sensitive Routing User Manual

Cisco Carrier Sensitive Routing User Guide

Version 1.1

Corporate Headquarters

Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000

800 553-NETS (6387)

Fax: 408 526-4100

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 ORIMPLIED, 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.

Cisco Carrier Sensitive Routing User Guide

Preface vii

Overview vii Who Should Use This Guide vii Document Organization viii Document Conventions viii Related Documentation and References ix Obtaining Documentation ix

World Wide Web ix Documentation CD-ROM ix Ordering Documentation ix Documentation Feedback x

Obtaining Technical Assistance x

Cisco.com x Technical Assistance Center x

Contacting TAC by Using the Cisco TAC Website xi Contacting TAC by Telephone xi

C O N T E N T S

C H A P T E R

1 Overview of Cisco Carrier Sensitive Routing 1-1

Prerequisites 1-1 CSR Components 1-2 CSR Basics 1-2

PostgreSQL Database 1-3 CSR Application 1-3

Ingress Rejection Rules 1-4 Egress Rejection Rules 1-4 Selection Rules 1-4

CSR GUI 1-4

CSR Limitations 1-5

2 PostgreSQL Database Operations and Functionalities 2-1

Database Operations 2-1

Activating the Database 2-1 Exiting the Database 2-2 Reactivating the Database 2-2

Cisco Carrier Sensitive Routing User Guide

iii

Contents

Exporting a Database 2-2 Reintializing a Database 2-3

Database Functionalities 2-3

Database Tables 2-4

Configuration Tables 2-4 Dataset Tables 2-10

PostgreSQL Database Command Summary 2-17

C H A P T E R

3 Cisco Carrier Sensitive Routing Application Operations 3-1

Activating CSR 3-1

Single Instance 3-1

CSR as a Daemon 3-1 CSR as a User Process 3-2

Multiple Instances 3-2

Deactivating CSR 3-3

4 CSR GUI Functionalities 4-1

Activating the GUI 4-1 Configuring CSR with the GUI 4-2

Changing Configuration Settings 4-2

Changing Log Levels 4-3 Changing App Priority 4-4 Changing Connection Port 4-4 Enabling Test Routes Accounting 4-4 Saving Configuration Settings 4-4

Adding, Modifying, and Removing Gatekeepers 4-5

Adding Gatekeepers 4-5 Modifying Gatekeepers 4-9 Removing Gatekeepers 4-10 Setting Threads for Processing Calls and Call Queue Size 4-11 Swapping Datasets 4-12

Updating Active Datasets 4-12

Creating, Modifying, and Deleting Carriers 4-13

Creating Carriers 4-14 Modifying Carriers 4-15 Deleting Carriers 4-16

Creating, Modifying, and Deleting Contacts 4-17

Creating Contacts 4-17 Modifying Contacts 4-18

Cisco Carrier Sensitive Routing User Guide

Deleting Contacts 4-18

Creating, Modifying, and Deleting Contact Lists 4-19

Creating Contact Lists 4-19 Modifying Contact Lists 4-20 Deleting Contact Lists 4-21

Creating, Modifying, and Deleting Egress Route Attributes 4-21

Creating Egress Route Attributes 4-21 Modifying Egress Route Attributes 4-23 Deleting Egress Route Attributes 4-25

Creating, Modifying, and Deleting Ingress Route Attributes 4-26

Creating Ingress Route Attributes 4-26 Modifying Ingress Route Attributes 4-28 Deleting Ingress Route Attributes 4-29

Creating, Modifying, and Deleting Match Patterns 4-30

Creating Match Patterns 4-30 Modifying Match Patterns 4-31 Deleting Match Patterns 4-31

Creating, Modifying, and Deleting Routes 4-32

Creating Routes 4-32 Modifying Routes 4-33 Deleting Routes 4-34

Creating, Modifying, and Deleting Rules 4-35

Creating Rules 4-35 Modifying Rules 4-37 Deleting Rules 4-38

Verifying Datasets 4-39

Contents

Updating Inactive Datasets 4-39

Destroying Inactive Datasets 4-40 Activating Inactive Datasets 4-41

CSR Commands 4-41

Sending Test Route Request Commands to an Active CSR Application 4-42 Updating Logging Level 4-44 Loading the Active Dataset 4-44 Resetting Call Accounting 4-45 Updating Gatekeepers 4-45

Cleaning Test Results 4-45 Checking CSR Version 4-46 Multiple GUI Operation 4-46

Cisco Carrier Sensitive Routing User Guide

Contents

AP P E N D IX

GL O S SA RY

IN D E X

A Logging A-1

Configuring Syslog A-1

Examples A-2

Viewing Logs A-2

Sample logs A-3

B Data Schema B-1

Configuration Data Schema B-1 Dataset Schema B-5

C Error Conditions and Recoveries C-1

Database Connectivity Loss C-1 Gatekeeper Connectivity Loss C-2

Cisco Carrier Sensitive Routing User Guide

Preface

This preface describes the objective, audience, organization, and conventions of the Cisco Carrier Sensitive Routing User Guide.

It contains the following information:

• Overview, page-vii

• Who Should Use This Guide , page-vii

• Document Organization, page-viii

• Document Conventions, page-viii

• Related Documentation and References , page-ix

• Obtaining Documentation, page-ix

• Obtaining Technical Assistance , page-x

Overview

The Cisco Carrier Sensitive Routing User Guide provides information on operations and functionalities of Carrier Sensitive Routing (CSR) application, its graphical user interface (GUI) and the databases associated with it.

Who Should Use This Guide

Users of this guide should have knowledge of the following:

• UNIX operating system and commands

• SQL commands

• TCP/IP network that the CSR is connected to

• Sun/Solaris computer system

Cisco Carrier Sensitive Routing User Guide

vii

Document Organization

This guide is organized as follows:

Preface

Chapter1, “Overview of Cisco Carrier Sensitive Routing”

Chapter2, “PostgreSQL Database Operations and Functionalities ”

Chapter3, “Cisco Carrier Sensitive Routing Application Operations”

Chapter4, “CSR GUI Functionalities” Describes the CSR graphical user interface

AppendixA, “Logging” Describes the configuration of syslog and viewing

AppendixB, “Data Schema ” Describes the configuration data schema and

AppendixC, “Error Conditions and Recoveries ” Describes database and gatekeeper connectivity

Document Conventions

Following are conventions that might be used in this document.

Table1

Provides an overview of the postgreSQL database, CSR application, and CSR graphical user interface (GUI).

Describes the operations and functionalities of the postgreSQL database.

Describes the operations and functionalities of the CSR application.

functionalities.

logs.

dataset schema.

loss.

Convention Description

boldface Commands and keywords are in bold face .

italic Arguments for which you supply values are in italic. [] Keywords or arguments that appear within square brackets are optional. { x | y | z } Alternative, mutually exclusive, keywords are grouped in braces and

separated by vertical bars.

^ orCtrl Represent the key labeled Control. For example, when you read ^D or

Ctrl-D, you should hold down the Control key while you press the D key.

screen font

boldface screen font

<> Nonprinting characters, such as passwords, appear in angled brackets. [] Default responses to system prompts are in square brackets.

Terminal sessions and information the system displays are in screen

font.

Information you must enter is in boldface screen font.

viii

Cisco Carrier Sensitive Routing User Guide

Preface

Related Documentation and References

Translated documentation is available at this URL:

http://www.cisco.com/public/countries_languages.shtml

Documentation CD-ROM

Cisco documentation and additional literature are available in a Cisco Documentation CD-ROM package, which is shipped with your product. The Documentation CD-ROM is updated monthly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual subscription.

Ordering Documentation

You can order Cisco documentation in these ways:

• Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from

the Networking Products MarketPlace:

http://www.cisco.com/cgi-bin/order/order_root.pl

• Registered Cisco.com users can order the Documentation CD-ROM through the online Subscription

Store:

http://www.cisco.com/go/subscription

• Nonregistered Cisco.com users can order documentation through a local account representative by

calling Cisco Systems Corporate Headquarters (California, U.S.A.) at 408526-7208 or, elsewhere in North America, by calling 800553-NETS (6387).

Cisco Carrier Sensitive Routing User Guide

Obtaining Technical Assistance

Documentation Feedback

You can submit comments electronically on Cisco.com. In the Cisco Documentation home page, click the Fax or Email option in the “Leave Feedback” section at the bottom of the page.

You can e-mail your comments to bug-doc@cisco.com. You can submit your comments by mail by using the response card behind the front cover of your

document or by writing to the following address: Cisco Systems

Attn: Document Resource Connection 170 West Tasman Drive San Jose, CA 95134-9883

We appreciate your comments.

Obtaining Technical Assistance

Cisco provides Cisco.com as a starting point for all technical assistance. Customers and partners can obtain online documentation, troubleshooting tips, and sample configurations from online tools by using the Cisco Technical Assistance Center (TAC) Web Site. Cisco.com registered users have complete access to the technical support resources on the Cisco TAC Web Site.

Preface

Cisco.com

Cisco.com is the foundation of a suite of interactive, networked services that provides immediate, open access to Cisco information, networking solutions, services, programs, and resources at any time, from anywhere in the world.

Cisco.com is a highly integrated Internet application and a powerful, easy-to-use tool that provides a broad range of features and services to help you with these tasks:

• Streamline business processes and improve productivity

• Resolve technical issues with online support

• Download and test software packages

• Order Cisco learning materials and merchandise

• Register for online skill assessment, training, and certification programs

If you want to obtain customized information and service, you can self-register on Cisco.com. To access Cisco.com, go to this URL:

http://www.cisco.com

Technical Assistance Center

The Cisco Technical Assistance Center (TAC) is available to all customers who need technical assistance with a Cisco product, technology, or solution. Two levels of support are available: the Cisco TAC WebSite and the Cisco TAC Escalation Center.

Cisco Carrier Sensitive Routing User Guide

Preface

Cisco TAC inquiries are categorized according to the urgency of the issue:

• Priority level 4 (P4)—You need information or assistance concerning Cisco product capabilities,

• Priority level 3 (P3)—Your network performance is degraded. Network functionality is noticeably

• Priority level 2 (P2)—Your production network is severely degraded, affecting significant aspects

• Priority level 1 (P1)—Your production network is down, and a critical impact to business operations

The Cisco TAC resource that you choose is based on the priority of the problem and the conditions of service contracts, when applicable.

Cisco TAC Web Site

You can use the Cisco TAC Web Site to resolve P3 and P4 issues yourself, saving both cost and time. The site provides around-the-clock access to online tools, knowledge bases, and software. To access the Cisco TAC Web Site, go to this URL:

Obtaining Technical Assistance

product installation, or basic product configuration.

impaired, but most business operations continue.

of business operations. No workaround is available.

will occur if service is not restored quickly. No workaround is available.

http://www.cisco.com/tac

All customers, partners, and resellers who have a valid Cisco service contract have complete access to the technical support resources on the Cisco TAC Web Site. The Cisco TAC Web Site requires a Cisco.com login ID and password. If you have a valid service contract but do not have a login ID or password, go to this URL to register:

http://www.cisco.com/register/

If you are a Cisco.com registered user, and you cannot resolve your technical issues by using the Cisco TAC Web Site, you can open a case online by using the TAC Case Open tool at this URL:

http://www.cisco.com/tac/caseopen

If you have Internet access, we recommend that you open P3 and P4 cases through the Cisco TAC WebSite.

Cisco TAC Escalation Center

The Cisco TAC Escalation Center addresses priority level 1 or priority level2 issues. These classifications are assigned when severe network degradation significantly impacts business operations. When you contact the TAC Escalation Center with a P1 or P2 problem, a Cisco TAC engineer automatically opens a case.

To obtain a directory of toll-free Cisco TAC telephone numbers for your country, go to this URL:

http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml

Before calling, please check with your network operations center to determine the level of Cisco support services to which your company is entitled: for example, SMARTnet, SMARTnet Onsite, or Network Supported Accounts (NSA). When you call the center, please have available your service agreement number and your product serial number.

Cisco Carrier Sensitive Routing User Guide

Obtaining Technical Assistance

Preface

xii

Cisco Carrier Sensitive Routing User Guide

C H A P T E R

Overview of Cisco Carrier Sensitive Routing

The Cisco Carrier Sensitive Routing (CSR) application provides end users with the capability to manipulate the routing of calls from the gatekeeper based on the ingress carrier and the DNIS. The routing can be based on QoS along with many other attributes pertaining to a carrier. With CSR, you can provision data specific to carriers that pertain to your network to maximize cost, QoS, and carrier relations. CSR can run on a Sun/Solaris system that has a network connection to gatekeepers.

This chapter contains the following sections:

• Prerequisites, page 1-1

• CSR Components, page 1-2

• CSR Basics, page 1-2

• CSR Limitations, page 1-5

Prerequisites

• Root access to a UNIX machine for the following tasks:

• Configured Cisco gatekeeper and gateway

• Network that provides DNS capabilities

• Knowledge of the following:

–

Create users

–

Modify Syslog.conf

–

Setting database security

–

UNIX operating system and commands

–

SQL commands

–

TCP/IP network that the CSR is connected to

–

Sun computer system

Carrier Sensitive Routing User Guide

1-1

CSR Components

The three major components of CSR are as follows.

• postgreSQL Database

• CSR application

• CSR GUI

The CSR GUI and the CSR application are not directly connected. They are both connected to the database. Figure1-1 illustrates these components.

Figure1-1 CSR Components

Chapter1 Overview of Cisco Carrier Sensitive Routing

CSR Basics

This section describes the basic operation of CSR. After CSR is started, it registers with the gatekeeper connected to a network. Any one or a combination

of the following registration messages are used:

• ARQ

• LRQ

• DRQ

• BRQ

• URQ

• RAI

• LCF

• LRJ

• IRR

The gatekeeper responds with any of the following messages:

• ANI

• DNIS

• Source carrier

• Destination carrier

1-2

Carrier Sensitive Routing User Guide

Chapter1 Overview of Cisco Carrier Sensitive Routing

CSR evaluates the predetermined selection and rejection criteria as part of the source carrier and DNIS information to determine what routing information to return to the gatekeeper.

Note CSR can operate with multiple gatekeepers. CSR passes through the ANI, but its work is not based

on the ANI. If the CSR receives the destination carrier, it passes the call through with the same information that it receives.

PostgreSQL Database

The postgreSQL database stores all the provisioned data associated with the CSR. The data can be entered into the database by using the GUI or by importing. The database supports active dataset, inactive dataset, and configuration data.

Information contained in the active and inactive datasets includes:

• Carrier Table —Contains a list of carriers and associated attributes.

• Contact List Table—Contains a relationship of contacts to a key.

• Contacts Table—Contains a list of RAS addresses (zones) and associated attributes.

CSR Basics

• Egress Route Attributes Table—Contains a list of egress attributes and associated data.

• Egress Routes Table —Contains a list of egress attributes and associated routes.

• Ingress Route Attributes Table—Contains a list ingress attributes and associated data.

• Ingress Routes Table —Contains a list of ingress attributes and associated routes.

• Match Patterns Table—Contains a list of match patterns and associated routes.

• QoS Table —Contains a list of relative QoS values associated to route, ingress, and egress.

• Routes Table —Contains a list of routes and associated rules.

• Rules Table—Contains a list of rules and associated attributes (selection/rejection).

Configuration data contained in the database includes:

• Gatekeepers Table—Contains a list of gatekeepers and associated registration messages.

• Filters Table—Contains a list of gatekeepers and associated filters.

• Configuration Settings Table—Contains logging level, application priority, incoming connection

port and test routes accounting flag.

• TestRoutes —A record is added to this when a test route command is issued.

• TestOutputs —A set of records is added to this table after the test route command is complete.

• LogEntries —A set of records is added to this table after the test route command is complete.

• StringResources—Logging strings are located here.

CSR Application

The CSR application contains the logic (selection and rejection) to determine the proper routing for calls based on inputs from the gatekeeper. CSR operates by the rules described in the following section.

Carrier Sensitive Routing User Guide

1-3

CSR Basics

Ingress Rejection Rules

• Reject Max Origination Percentage

• Reject Max Ingress Units

• Reject Max Ingress Units per Route

Egress Rejection Rules

• Reject Egress Cost Greater than Ingress

• Reject Insufficient QoS

• Reject Max Egress Units Exceeded

• Reject Max Egress Units per Route Exceeded

• Prevent ITSP to ITSP

Selection Rules

Chapter1 Overview of Cisco Carrier Sensitive Routing

CSR GUI

• Select Min Cost per Egress Route

• Select Best QoS

• Select Same Carrier

• Select Percentage Egress

• Select Preferred Carrier

CSR operates on an internal copy of the active dataset, which is loaded from the active dataset of the postgreSQL database. CSR can also operate without the postgreSQL database running as long as it has an active dataset. For more information on the active dataset, see the “ Loading the Active Dataset”

section on page4-44.

The CSR GUI provides an interface that can be used to enter, change, and modify provisioned data in the postgreSQL database. You can import data into the database with the import capabilities provided by postgreSQL. The CSR GUI can run on Sun/Solaris and Microsoft NT platforms.

1-4

Carrier Sensitive Routing User Guide

Chapter1 Overview of Cisco Carrier Sensitive Routing

CSR Limitations

• When two rules are available (a rule associated with the carrier and a rule associated with a route),

the rule associated with the carrier is chosen first. If one of the rules (carrier’s rule) does not exist, the rule associated with a route is used.

• When two contact lists are available (the contact list associated with the carrier and the contact list

associated with the EgressRouteAttribute), the carrier’s contact list is used first. If one of the contact lists (carrier’s contact list) does not exist, then the contact list associated with the EgressRouteAttribute is used.

• If a contact is provisioned with a DNS name and a DNS server is not found—that is, cannot get an

IP address—the dataset verification fails and the CSR cannot be started correctly.

• Static triggers are not supported by the CSR.

• Performance may deteriorate if more than five gatekeepers are connected to the CSR. This is also

related to hardware capabilities and call volume.

CSR Limitations

Carrier Sensitive Routing User Guide

1-5

CSR Limitations

Chapter1 Overview of Cisco Carrier Sensitive Routing

1-6

Carrier Sensitive Routing User Guide

PostgreSQL Database Operations and Functionalities

This chapter describes the operations and functionalities of the postgreSQL database and contains the following sections:

• Database Operations, page 2-1

• Database Functionalities, page 2-3

The postgreSQL database is a relational database management system. A database in this management system stores entities such as carriers, rules, contacts, routes, and the relationships among the entities. The management system can manage many different databases simultaneously. The CSR creates a database in this system and performs call routing based on the data in the database.

Database Operations

C H A P T E R

This section describes the following tasks:

• Activating the Database

• Exiting the Database

• Reactivating the Database

• Exporting a Database

• Reintializing a Database

Activating the Database

To activate the postgreSQL database, perform the following steps:

Step 1 Log in to the Solaris system by entering postgres as the user.

A “postgres” password prompt may appear.

Step 2 Enter the following command:

/etc/init.d/postgres_init start

This command calls postgreSQL command postmaster -S -i -B 40 -N 20 -D /usr/local/pgsql/data . The parameters are described as follows:

Cisco Carrier Sensitive Routing User Guide

2-1

Database Operations

Note For servers with console login, disable Xwindow in the file .profile, so the database can be restarted

Chapter2 PostgreSQL Database Operations and Functionalities

• -S—Tells the postmaster to run in silent mode. This is not recorded to a log file.

• -i—Tells postmaster to allow network connections. If this is not set, the postmaster accepts

connections only from the local host.

Note This is needed for the GUI to connect to the database even when it is running on the same

machine.

• -B and -N—Set up shared memory segments.

• -D—Tells the postmaster the location of the database files.

from a reboot.

Exiting the Database

To exit the postgreSQL database, perform the following steps:

Step 1 Log in to the Solaris system by entering postgres as the user.

A “postgres” password prompt may appear.

Step 2 Enter the following command:

/etc/init.d/postgres_init stop

This command calls the postgreSQL command pg_ctl stop.

Reactivating the Database

To reactivate the postgreSQL database, perform the following steps.

Step 1 Log in into the Solaris system by entering postgres as the user.

A “postgres” password prompt may appear.

Step 2 Enter the following command:

/etc/init.d/postgres_init restart

2-2

This command calls the postgreSQL command pg_ctl restart. The parameters for this command are described in “ Activating the Database” section on page2-1.

Cisco Carrier Sensitive Routing User Guide

Chapter2 PostgreSQL Database Operations and Functionalities

Exporting a Database

To export a database to a text file or to back up the entire database system, perform the following steps:

Exporting to a Text File

Step 1 Export a database into a text file by entering the following command:

pg_dump –x databasename > outfile

Note "-x" is optional. When it is used, the “dumped” database loses the ownership information.

Step 2 Reload the dataset by entering the following command:

psql –e database < outfile

Note "-e" is optional. When it is used, every log message “echoes” on the screen.

Database Operations

Backing Up the Database System

You can back up the database system file directory /usr/local/pgsql/data/base into a tar file.

Reintializing a Database

To reinitialize a database, the existing database must be destroyed, and a new one must be created. To reinitialize a database, performing the following steps:

Step 1 Destroy the database by entering the following command with “csrdb” as the name of the database:

dropdb csrdb

Note The database to be destroyed must not be connected to the CSR application, CSR GUI, and

pgsql.

Step 2 Create a new database by entering the following command:

createcsrdb csrdb

After the database is re-created, the CSR and CSR GUI can be restarted and connected to the new database. If “csrdb” is not used as the name of the database, note the following:

• To have CSR started upon reboot of the Solaris system, modify the following files:

–

etc/init.d/csr_init

–

/etc/rc2.d/S99csr_init

• To start CSR from the command prompt, specify the database name in command csr newdbname &

Cisco Carrier Sensitive Routing User Guide

2-3

Database Functionalities

This section describes the following:

• Database Tables, page 2-4

• PostgreSQL Database Command Summary , page 2-17

Database Tables

This section describes database tables, constraints placed on each table, and relationships between tables.

Note Advanced knowledge of SQL is required to access the database through SQL commands. Use

the psql interface to access an SQL prompt. For more detail on psql interface, see the postgreSQL online manual.

Chapter2 PostgreSQL Database Operations and Functionalities

Configuration Tables

Note The configuration data must contain one record that is created when the user executes the

See AppendixB, “Data Schema ,” for the database script to create database tables, constraints and relationships.

createcsrdb command.

2-4

Cisco Carrier Sensitive Routing User Guide

Chapter2 PostgreSQL Database Operations and Functionalities

Table2-1 Configuration Data Table

Name Type

ActiveDataset text NO ‘_1’ Valid values:

LoggingLevel text NO ‘Error’ Valid values:

CSR_ID varchar(64) NO ID used to register with

CSR_Version text Version of CSR. This is

GKTMP_Version integer Version of GKTMP.

Priority integer NO 1 >=1 Priority to register this

ListenPort integer >0 and < 32767 TCP port to listen for

Database Functionalities

Allow Null Default Constraints Comments

There are two datasets

• _1

• _2

• error

• info

• debug

in the CSR (active and inactive). There are two of each table for entities that are created (for example, Carriers_1, Carriers_2). The active dataset marks which of the above is active.

When the application, is active, logs are generated. This marks the level of logging that is being done. During realtime, this runs only at error level to avoid performance deterioration.

the gatekeeper which application is connecting. (Also known as the application ID).

entered when the GUI requests it from the CSR.

This is entered when the GUI requests it from the CSR.

application to the gatekeeper.

incoming connection. A gatekeeper or simulator may connect to the CSR, and this is the port to connect to.

Cisco Carrier Sensitive Routing User Guide

2-5

Database Functionalities

Chapter2 PostgreSQL Database Operations and Functionalities

Table2-1 Configuration Data Table (continued)

Allow

Name Type

ThreadCount integer NO 10 Number of threads in

MaxSizeOfQueue integer NO 5000 Maximum size of the

TestRoutesAccou

boolean NO FALSE When issuing test

ntingEnabled

RejectSrcCarrierI

boolean NO FALSE If this rejection rule

nactive

RejectNullSrcCar

boolean NO FALSE If this rejection rule

rier

RejectSrcCarrier

boolean NO FALSE If this rejection rule

Unknown

RejectDestination

boolean NO FALSE If this rejection rule

Unknown

RejectSrcPercent

boolean NO FALSE If this rejection rule

age

Null Default Constraints Comments

the working pool that handle routes in the rules engine. This number must be adjusted for different systems.

queue to handle calls. Typically, the queue is either empty or has an entry. During busy hours, the queue may become larger and cause long turn-around times for the calls to be routed.

commands through the GUI, the call units are updated if this is set to True.

applies, the CSR returns a rejection instead of a null body.

2-6

Cisco Carrier Sensitive Routing User Guide

Chapter2 PostgreSQL Database Operations and Functionalities

Table2-1 Configuration Data Table (continued)

Name Type

RejectSrcUnits boolean NO FALSE If this rejection rule

RejectNoDstCarrierboolean NO FALSE If this rejection rule

Table2-2 Gatekeeper Table

Name Type

GKKey integer NO Primary key. Key of the

GKID varchar(64) NO ID of the gatekeeper.

GK_IP inet NO IP address of the

GK_Port integer NO >0 and < 32767 Port that the gatekeeper

ListenARQ boolean NO FALSE Set to TRUE if

ListenLRQ boolean NO FALSE Set to TRUE if

ListenIRR boolean NO FALSE Set to TRUE if

ListenDRQ boolean NO FALSE Set to TRUE if

ListenRRQ boolean NO FALSE Set to TRUE if

ListenURQ boolean NO FALSE Set to TRUE if

ListenLCF boolean NO FALSE Set to TRUE if

Database Functionalities

Allow Null Default Constraints Comments

applies, the CSR returns a rejection instead of a null body.

Allow Null Default Constraints Comments

gatekeeper.

Must be unique.

gatekeeper.

is listening on.

registering for this type of message.

Cisco Carrier Sensitive Routing User Guide

2-7

Database Functionalities

Chapter2 PostgreSQL Database Operations and Functionalities

Table2-2 Gatekeeper Table (continued)

Allow

Name Type

ListenLRJ boolean NO FALSE Set to TRUE if

ListenRAI boolean NO FALSE Set to TRUE if

ListenBRQ boolean NO FALSE Set to TRUE if

ConnectionState text NO Valid values:

Null Default Constraints Comments

registering for this type of message.

If set to connect, the

• connect

• disconnect

CSR attempts to connect to this gatekeeper.

Table2-3 TestRoutes Table

Allow

Name Type

Null Default Constraints Comments

TestKey integer NO Primary key. Key

of this test route. TestTime time Time of the test. TestDate date Date of the test. DatasetID text ‘_1’ Valid values:

• _1

• _2

This marks which

dataset to issue the

test on.

ANI varchar(64) ANI message. DNIS varchar(64) DNIS message. SrcCarrierID varchar(64) ID of source

carrier. DstCarrierID varchar(64) ID of destination

carrier. RunMe Boolean NO FALSE Set to TRUE when

this test is to be run

by the CSR. HomeCarrierID varchar(64) ID of home carrier. ResultCode text Result code for this

test.

2-8

Cisco Carrier Sensitive Routing User Guide

Chapter2 PostgreSQL Database Operations and Functionalities

Table2-4 TestOutputs Table

Name Type

TestKey integer NO Foreign key. Key of this test (see

SelectOrder integer NO For a given TestKey, this shows

DstCarrierID varchar(64) NO ID of Destination Carrier. ListKey integer NO Specifies key for the contact list

IsSelected boolean NO FALSE Specifies whether this is a

Database Functionalities

Allow Null Default Constraints Comments

TestRoutes table).

the order in which the carriers will be returned. The database does not guarantee the original ordering.

associated with the particular carrier.

selected carrier.

Table2-5 LogEntries Table

Allow

Name Type

Null Default Constraints Comments

TestKey integer NO Foreign key. Test key that this log

file was generated for.

EntryOrder integer NO For a given Test key, this field is

used to show the order in which the log events were generated. The database does not guarantee the original ordering.

LogString varchar(1024) NO The log entries associated with

the test run.

Caution The following table should not be modified or deleted. It consists of error messages that are logged.

The CSR application does not work without this table.

Table2-6 StringResources Table

Allow

Name Type

Null Default Constraints Comments

ResourceKey integer NO Primary key. Key to the

resource.

ResourceString text NO String (error value).

Cisco Carrier Sensitive Routing User Guide

2-9

Database Functionalities

Chapter2 PostgreSQL Database Operations and Functionalities

Table2-7 Filters Table

Allow

Name Type

FilterKey integer NO Primary key. Key of

GKID varchar(64) NO Foreign key. ID of the

MsgType text NO Valid values:

Null Default Constraints Comments

the filter.

gatekeeper associated with this filter.

The message type for

• ARQ

• LRQ

• RRQ

• URQ

• LCF

this filter.

• LRJ

• DRQ

• BRQ

• IRR

• RAI

FilterType text NO Valid values:

• endpoint

• supportedprefix

• destinationinformation

• remoteextesionaddress’

• redirectreason

• answercall

• notificationonly

Type of filter.

Value text NO Value of this message.

There are certain values for each filter type enforced by the GUI.

Dataset Tables

Cisco Carrier Sensitive Routing User Guide

2-10

The dataset tables use functionality that is specific to postgreSQL, that is, table inheritance. This allows a table to be created and other tables to be inherited from it. For example, you can create a Carriers Table and have tables Carriers_1 and Carriers_2 inherit from it. This allows two datasets to be created.

Chapter2 PostgreSQL Database Operations and Functionalities

Table2-8 Carriers Table

Name Type

CarrierKey integer NO <>0 Primary key. Key

CarrierName varchar(64) NO Name of carrier. CarrierType text NO Valid values:

CarrierID varchar(64) NO ID of carrier.

MaxIngressUnits integer >=0 Maximum

MaxEgressUnits integer >=0 Maximum egress

RuleKey integer Foreign key. Rule

ListKey integer NO Foreign key. Key

isActive boolean NO TRUE Indicates whether

Database Functionalities

Allow Null Default Constraints Comments

of the carrier.

Type of carrier.

• home

• itsp

• tdm

Must be unique.

ingress units.

units.

associated with this specific carrier.

of the list.

carrier is active.

Note Tables Carriers_1 and Carriers_2 can inherit from the Carriers table.

Table2-9 MatchPatterns Table

Allow

Name Type

Null Default Constraints Comments

PatternKey integer NO <> 0 Primary key. Key of the

pattern.

Pattern varchar(64) NO Unique. Valid values

are 0 to 9, a to f, A to F, *, and “.”

RouteKey integer Foreign key. Route that

this pattern is associated with.

Cisco Carrier Sensitive Routing User Guide

2-11

Database Functionalities

Chapter2 PostgreSQL Database Operations and Functionalities

Note Tables MatchPatterns_1 and MatchPatterns_2 can inherit from this table.

Table2-10 Routes Table

Allow

Name Type

RouteKey integer NO <> 0 Primary key. Key of the route. RouteName text Name of the route. RuleKey integer Foreign key. Rule associated

Note Tables Routes_1 and Routes_2 can inherit from the Routes table.

Null Default Constraints Comments

with this route.

Table2-11 Rules Table

Allow

Name Type

Null Default Constraints Comments

RuleKey integer NO <> 0 Primary key.

Key of the rule.

RuleName text Optional name

to describe this rule.

IsDefaultRule boolean NO FALSE Indicates if

this is the default rule. One default rule must exist.

MinQoS integer >= 1 and <=9 Minimum

quality of service. This is used with RejectInsuffic ientQoS rule.

PreferredCarrierKey integer Foreign key.

Key to a carrier. Used only when

SelectPreferr edCarrier

rule is used.

2-12

Cisco Carrier Sensitive Routing User Guide

+ 80 hidden pages