Database Structure

This appendix presents information on the Cisco Resource Pool Manager Server (Cisco RPMS) database structure. It provides programmers and system administrators with database information they can use to write custom programs that access the Cisco RPMS.

This appendix includes the following sections:

Call Information Data

This section describes the call discrimination table and the call types table.

cs_call_dscrmnt table

The cs_call_dscrmnt table (Table E-1) stores call discrimination information. Each row represents a call type/DNIS group combination that is not allowed.

Table E-1: cs_call_dscrmnt table

Column Description

cd_name

Unique name for call discrimination entry. The primary key is created on this column.

cd_id

Unique ID number for call discrimination entry.

dnis_grp_id

DNIS group ID number defined in cs_dnis_grp table. A unique index is created for this column.

call_type_id

Call type ID number. Call type ID numbers are defined in cs_call_type table.

cycle_number

Increments when a record is updated. Internally used to identify the current record.

cs_call_type table

The cs_call_type table (Table E-2) stores call type information. Each row represents a call type with a unique ID.

Table E-2: cs_call_type table

Column Description

type_name

Call type name. A unique index is created for this column.

call_type_id

Unique ID number for each call type entry. The primary key is created on this column.

dscr

Description of call type.

cycle_number

Increments when a record is updated. Internally used to identify the current record.

Customer Profile Data

This section describes customer profile and related tables.

cs_customer table

The cs_customer table (Table E-3) defines customer profile settings and contains attributes that have singular values. Multi-valued attributes such as DNIS groups, VPDN groups, and resource groups are stored in separate tables.

Table E-3:

Column Description

customer_name

Unique name of the customer profile. The primary key is created on this column.

customer_id

Unique ID number of the customer profile entry. A unique index is created for this column.

descdscr

Description of the customer profile.

call_treatment

Call treatment string.

non_ovfl_limit

Maximum number of standard sessions for the customer profile.

ovfl_limit

Maximum number of overflow sessions allowed above `non_ovfl_limit'.

non_ovfl_thld

Threshold for non-overflow sessions.

ovfl_thld

Threshold for overflow sessions.

ovfl_call_rjct_thld

Threshold for rejected overflow calls.

call_rjct_thld

Threshold for rejected calls.

cycle_number

Increments when a record is updated. Internally used to identify the current record.

cs_customer table

cs_cust_dnis_grp table

The cs_cust_dnis_ grp table (Table E-4) associates DNIS groups and call types with customer profiles.

Note Multiple DNIS groups can be associated with a single customer profile.

Table E-4: cs_cust_dnis_ group table

Column Description

customer_id

ID number of the customer profile.

dnis_grp_id

ID number of the DNIS group associated with the customer profile. The primary key is created on this column.

call_type_id

Call type ID allowed for the customer with the resource group. The primary key is created on this column.

cs_cust_res_grp table

The cs_cust_res_pkg table (Table E-5) associates resource groups with customer profiles.

Note Multiple resource groups can be associated with a single customer profile.

Table E-5: cs_cust_res_pkg table

Column Description

customer_id

ID number of the customer profile. The primary key is created on this column.

rsc_grp_id

Resource group ID number of resource group associated with customer profile. The primary key is created on this column.

call_type_id

Call type ID.

svc_grp_id

Resource service ID. 0 means none.

cs_cust_vpdn_grp table

The cs_cust_vpdn_grp table (Table E-6) associates VPDN groups with customer profiles.

Note Multiple VPDN groups can be associated with a single customer profile.

Table E-6: cs_cust_vpdn_grp table

Column Description

customer_id

ID number of the customer profile. The primary key is created on this and the vpdn_grp_id column..

vpdn_grp_id

ID number of VPDN group associated with customer profile.

DNIS Data

This section describes DNIS-related tables.

cs_dnis_grp table

The cs_dnis_grp table (Table E-7) defines DNIS groups.

Table E-7: cs_dnis_grp table

Column Description

dnis_grp_name

Unique name for the DNIS group. The primary key is created on this column.

dnis_grp_id

Unique DNIS group number. An index is created for this column.

descdscr

Description.

cas_ovr_call_type

CAS override call type ID number defined in cs_call_type table.

cycle_number

Increments when a record is updated. Internally used to identify the current record.

cs_dnis table

The cs_dnis table (Table E-8) associates DNIS numbers with DNIS groups.

Note A DNIS number can only be associated with one DNIS group.

Table E-8: cs_dnis table

Column Description

dnis

DNIS number (wildcards OK). The primary key is created on this column.

dnis_grp_id

DNIS group ID number. A unique index is created for this column.

ref_number

Reference number.

Resource Data

This section describes resource-related tables.

cs_rsc_grp table

The cs_rsc_grp table (Table E-9) defines resource groups that are located on the NAS(es).

Table E-9: cs_rsc_grp table

Column Description

rsc_grp_name

Unique resource group name. The primary key is created on this column.

rsc_grp_id

Resource group ID number. A unique index is created for this column.

dscr

Description of the resource group.

cycle_number

Increments when a record is updated. Internally used to identify the current record.

cs_svc_grp table

The cs_svc_grp table (Table E-10) defines resource services.

Table E-10: cs_svc_grp table

Column Description

svc_grp_name

Unique resource group name. The primary key is created on this column.

svc_grp_id

Unique resource service ID number. A unique index is created for this column.

dscr

Description of VPDN group.

svc_type

Service type string.

svc_params

Optional service specific parameters.

cycle_number

Increments when a record is updated. Internally used to identify the current record.

VPDN Data

This section describes VPDN-related tables.

cs_vpdn_grp table

The cs_vpdn_grp table (Table E-11) defines vpdn groups.

Table E-11: cs_vpdn_grp table

Column Description

vpdn_grp_name

Unique VPDN group name. The primary key is created on this column.

vpdn_grp_id

Unique VPDN group ID number. Unique index is created for this column.

dscr

Description of the VPDN group.

hg_name

Home gateway name.

hg_info

Home gateway information.

hg_pwd

Home gateway password.

nas_name

NAS name.

nas_pwd

NAS password.

tunnel_id

Tunnel ID number.

tunnel_protocol

Tunnel protocol string (L2F or L2TP).

max_mlp_per_hg

Maximum MLP bundles per home gateway.

max_links_per_mlp

Maximum links per MLP bundle.

non_ovfl_limit

Maximum number of standard sessions.

ovfl_limit

Maximum number of overflow sessions allowed above the `non_ovfl_limit'.

vpdn_grp_thld

Threshold for VPDN group counter.

l2tp_pwd

L2TP password.

load_bal_type

Load balancing type number.

cycle_number

Increments when a record is updated. Internally used to identify the current record.

cs_vpdn_grp_ip table

The cs_vpdn_grp_ip table (Table E-12) associates IP endpoints with VPDN groups.

Table E-12: cs_vpdn_grp_ip table

Column Description

vpdn_grp_id

VPDN group ID number. The primary key is created on this and the ip_end column.

ip_end

IP end point.

ip_end_limit

Limit on IP end point.

ip_end_thld

Threshold for VPDN IP endpoint counter.

ip_end_ordinal

Order of IP end point within a VPDN group

cs_vpdn_grp_dnis table

The cs_vpdn_grp_dnis table (Table E-13) associates DNIS numbers or domain names with VPDN groups.

Table E-13: cs_vpdn_grp_dnis table

Column Description

vpdn_grp_id

VPDN group ID number. An index is created for this column.

dnis_domain

DNIS or domain name. The primary key is created on this column.

dscr

Description of DNIS or domain entry.

Report Data

This section describes report-related tables.

cs_rpt_type table

The cs_rpt_type table (Table E-14) defines report types.

Table E-14: cs_rpt_type table

Column Description

type_name

Report type name such as call, customer profile, or user-defined report setting name. The primary key is created on this column.

type_id

Unique report type ID number. A unique index is created for this column.

type_category

Report type category number.

dscr

Description of report type.

cycle_number

Incremented when a record is updated. Internally used to identify the current record.

cs_rpt_type_detail table

The cs_rpt_type_detail table (Table E-15) lists the details of report types. Each entry includes which attributes are included in a report type, the order in which the attributes are displayed, which attributes are used for sorting, and whether the sorting attributes are sorted in ascending or descending order.

Table E-15: cs_rpt_type_detail table

Column Description

type_id

Unique report type ID number. The primary key is created on this and the attr_id column.

attr_id

Unique attribute ID number.

ordinal

Order of attribute in a report type.

enable_display

Displays or hides an attribute (`y' if displayed, `n' if hidden).

sort_method

Either 0 for ascending order or 1 for descending order.

field_no

Field number for attribute within report type category

cs_rpt_attr table

The cs_rpt_attr table (Table E-16) defines report attributes.

Table E-16: cs_rpt_attr table

Column Description

attr_name

Report attribute name. The primary key is created on this column.

attr_id

Unique report attribute ID number. A unique index is created for this column.

dscr

Description of attribute.

attr_type

Type of attribute (1: string, 2: number, 3: IP address, 4: phone number, 5: boolean, 6: time).

display_label

Display label in the report. If null, attr_name is displayed.

sortable

Indicates if the attribute is sortable or not (`y' for yes or `n' for no).

Internal Data

Internal tables define mapping between attributes and database objects. These tables contain information that is internal to Cisco RPMS.

cs_blob table

The cs_blob table (Table E-17) stores Cisco RPMS global configuration parameters.

Table E-17: cs_blob

Column Description

blob_name

Blob name. The primary key is created on this column.

blob_id

Unique ID number for blob. A unique index is created for this column.

cycle_number

Incremented when a record is updated. Internally used to identify the current record.

cs_blob_data table

The cs_blob_data table (Table E-18) stores each segment of data listed in cs_blob table.

Table E-18: cs_blob_data

Column Description

blob_id

Unique ID number for blob. The primary key is created on this and the blob_ordinal column.

blob_ordinal

Order of blob segments in blob_data column. The number starts with 1.

blob_data

Blob segment. The order of segment is kept by blob_ordinal.

Additional Internal Data Tables

The Cisco RPMS database is based on the CiscoSecure ACS for UNIX database and uses many of the CiscoSecure ACS tables. These include:

cs_user_profile
cs_group_profile
cs_profile
cs_profile_blob
cs_password
cs_privilege
cs_lock
cs_profile_attr_dict
cs_profile_col_dict
cs_id
cs_deleted_id
cs_trans_log

The following CiscoSecure ACS tables are not used:

cs_accounting_log
cs_user_accounting_attr_dict
cs_user_accounting

Column	Description
cd_name	Unique name for call discrimination entry. The primary key is created on this column.
cd_id	Unique ID number for call discrimination entry.
dnis_grp_id	DNIS group ID number defined in cs_dnis_grp table. A unique index is created for this column.
call_type_id	Call type ID number. Call type ID numbers are defined in cs_call_type table.
cycle_number	Increments when a record is updated. Internally used to identify the current record.

Column	Description
type_name	Call type name. A unique index is created for this column.
call_type_id	Unique ID number for each call type entry. The primary key is created on this column.
dscr	Description of call type.
cycle_number	Increments when a record is updated. Internally used to identify the current record.

Column	Description
customer_name	Unique name of the customer profile. The primary key is created on this column.
customer_id	Unique ID number of the customer profile entry. A unique index is created for this column.
descdscr	Description of the customer profile.
call_treatment	Call treatment string.
non_ovfl_limit	Maximum number of standard sessions for the customer profile.
ovfl_limit	Maximum number of overflow sessions allowed above `non_ovfl_limit'.
non_ovfl_thld	Threshold for non-overflow sessions.
ovfl_thld	Threshold for overflow sessions.
ovfl_call_rjct_thld	Threshold for rejected overflow calls.
call_rjct_thld	Threshold for rejected calls.
cycle_number	Increments when a record is updated. Internally used to identify the current record.

Column	Description
dnis_grp_name	Unique name for the DNIS group. The primary key is created on this column.
dnis_grp_id	Unique DNIS group number. An index is created for this column.
descdscr	Description.
cas_ovr_call_type	CAS override call type ID number defined in cs_call_type table.
cycle_number	Increments when a record is updated. Internally used to identify the current record.

Column	Description
dnis	DNIS number (wildcards OK). The primary key is created on this column.
dnis_grp_id	DNIS group ID number. A unique index is created for this column.
ref_number	Reference number.

Column	Description
rsc_grp_name	Unique resource group name. The primary key is created on this column.
rsc_grp_id	Resource group ID number. A unique index is created for this column.
dscr	Description of the resource group.
cycle_number	Increments when a record is updated. Internally used to identify the current record.

Column	Description
svc_grp_name	Unique resource group name. The primary key is created on this column.
svc_grp_id	Unique resource service ID number. A unique index is created for this column.
dscr	Description of VPDN group.
svc_type	Service type string.
svc_params	Optional service specific parameters.
cycle_number	Increments when a record is updated. Internally used to identify the current record.

Column	Description
vpdn_grp_name	Unique VPDN group name. The primary key is created on this column.
vpdn_grp_id	Unique VPDN group ID number. Unique index is created for this column.
dscr	Description of the VPDN group.
hg_name	Home gateway name.
hg_info	Home gateway information.
hg_pwd	Home gateway password.
nas_name	NAS name.
nas_pwd	NAS password.
tunnel_id	Tunnel ID number.
tunnel_protocol	Tunnel protocol string (L2F or L2TP).
max_mlp_per_hg	Maximum MLP bundles per home gateway.
max_links_per_mlp	Maximum links per MLP bundle.
non_ovfl_limit	Maximum number of standard sessions.
ovfl_limit	Maximum number of overflow sessions allowed above the `non_ovfl_limit'.
vpdn_grp_thld	Threshold for VPDN group counter.
l2tp_pwd	L2TP password.
load_bal_type	Load balancing type number.
cycle_number	Increments when a record is updated. Internally used to identify the current record.

Column	Description
type_id	Unique report type ID number. The primary key is created on this and the attr_id column.
attr_id	Unique attribute ID number.
ordinal	Order of attribute in a report type.
enable_display	Displays or hides an attribute (`y' if displayed, `n' if hidden).
sort_method	Either 0 for ascending order or 1 for descending order.
field_no	Field number for attribute within report type category

Column	Description
attr_name	Report attribute name. The primary key is created on this column.
attr_id	Unique report attribute ID number. A unique index is created for this column.
dscr	Description of attribute.
attr_type	Type of attribute (1: string, 2: number, 3: IP address, 4: phone number, 5: boolean, 6: time).
display_label	Display label in the report. If null, attr_name is displayed.
sortable	Indicates if the attribute is sortable or not (`y' for yes or `n' for no).

Column	Description
blob_name	Blob name. The primary key is created on this column.
blob_id	Unique ID number for blob. A unique index is created for this column.
cycle_number	Incremented when a record is updated. Internally used to identify the current record.

Table of Contents

Database Structure