|
|
This appendix describes the specifications, formats, and relationships for the configuration data (.dat) files used by the telephony controller software. Use this appendix as a guide when you need to reference configuration settings stored in the .dat files or make changes to the XECfgParm.dat and dmprSink.dat files.
 | Caution The XECfgParm.dat and dmprSink.dat files are the only configuration files that you should change with a text editor. Manage all other configuration files with the telephony controller configuration tool, which is described in more detail in the next section. With the exception of changes made to the XECfgParm.dat and dmprSink.dat files, Cisco does not support manual modification of the .dat files nor any method of configuration other than that made with the telephony controller configuration tool. |
For information on using the configuration tool to configure the Cisco SC2200 signaling controller, see the Cisco SC2200 Signaling Controller Configuration Tool Guide, 78-5943-xx. For the Cisco VSC2700 virtual switch controller, see the Cisco VSC2700 Virtual Switch Controller Configuration Tool Guide, 78-6262-xx.
The .dat files are text files that list all the components in the telephony controller and define how the telephony controller operates. To configure the telephony controller, you manually edit the XECfgParm.dat and dmprSink.dat files, then configure the rest of the .dat files with the telephony controller configuration tool. This configuration tool runs on an NT server and stores all configuration settings in an Access database on that server. To transfer the configuration from the database to the .dat files on the telephony controller, you use the procedure described in the "Installing Your Configuration Files" in "Preparing Your Telephony Controller."
The process of transferring the .dat files from the database to the telephony controller is a one-way process, so it is best to always make configuration changes using the configuration tool. If you manually change settings that are configured with the configuration tool, these settings will be overwritten the next time the configuration files are written to the telephony controller. The configuration tool modifes only data in the database; it never reads the .dat files on the telephony controller.
Collectively, the .dat files serve as a configuration database for the telephony controller. The structure of these files is based on a relational database paradigm and the nomenclature used within these files reflects this structure. Each file is a physical representation of a single relational table. As a result, the terms "file" and "table" are used interchangeably throughout this appendix. From a logical view, the terms have the same meaning.
Each row in each table is a record, which is made up of fields, that serve as the columns in the table. Each record has one or more primary keys and zero or more foreign keys. Consult the "Conventions" section in the Preface for definitions of primary and foreign keys.
Because the structure of the configuration files is optimized for database operation, it might take some time for people to learn to read them. If you want to learn to read these files, start with compTypes.dat file, which lists all the types of components that operate the telephony controller. Next, study the components.dat file, which lists the actual components configured for your telephony controller.
To access .dat files, log in to the telephony controller and change to the /opt/TransPath/etc directory. This directory contains the .dat files used by your system. You can open any of these text files with any ASCII text editor.
The following subsections describe each of the .dat files, which are listed in Table A-1. Each configuration file description provides some or all of the following:
| File Names | Section |
|---|---|
The alarmCats.dat file contains a definition for each alarm category in the system. Each alarm is defined by the following:
Table A-2 contains the alarmCats.dat field formats.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
almCategoryID | Integer | 8 | Unique identification number for an alarm category. [Primary Key] |
almCategoryName | String | 80 | Unique name of an alarm category. [Primary Key] This is the alarm type identifier in an MML message. |
severity | Integer | 1 | The 4 alarm severity values are:
|
reportedFlag | Text | 1 | The 2 reported flag categories are:
|
formatString | String | 80 | An alarm description that appears in MML messages. |
almDescription | String | 80 | An description of what the alarm represents. |
SNMP Trap Type to Generate | Integer | 1 | The 5 SNMP trap types are:
|
1 "Config Fail" 0 Y "Config Fail - Check Log" 3 2 "XE Rsrc Fail" 0 Y "Resource Fail - Check Log" 4 3 "Gen Fail" 0 Y "General Fail - Check Log" 3
This example identifies three alarm categories in the alarmCats.dat table. The first field (almCategoryID) uniquely identifies the alarm category definition record. The second field (almCategoryName) denotes the type of alarm (execution environment resource failure). The third field denotes the severity (informational). The fourth field indicates the alarm is reported to the management interface. The fifth field (formatString) is an MML message that lets you know to check the system logs for more information. The final field indicates the SNMP trap to generate.
The almCategoryName field is used as the primary key by programs and other data files and must not be changed in any record. All other fields can be changed.
Records must not be removed from the alarmCats.dat table, as this would remove the almCategoryName field and interfere with references to other files.
The auxSigPath.dat table contains all auxiliary signal network (ASN) interfaces, including those for the local network. As a result, it can be replicated on every machine.
The ASPid field is unique to every telephony controller within an ASN. This value is configured in XECfgParm.dat under the label "*.transpathId" and is a four-digit hexadecimal number.
The auxSigPath.dat table contains the TransPath SystemID of all systems in the ASN. The local ASP is identified by matching the TransPath SystemID to the transpathID field in XECfgParm.dat. Every ASP, both local and remote, is tracked using a concatenation of 0x000E + TransPath SystemId (for example, 0x000E001B).
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
TransPath SystemID | Hex | 4 | If this value does not exist or is set to 0, then the ASN is disabled. |
ASPid | Hex | 4 | [Primary Key] The "Instance number" of the TransPath system ID for a specific telephony controller. |
IPAddress | IP address | 8 | Use standard IP address. |
IPPort | Integer | 4 | Internet Protocol port. |
X.121_Addr | Integer | 12 | This is the X.121 address used to identify the network element (NE) across an X.25 network. |
73 192.11.12.123 13 444411112222 1b 192.11.12.2 15 111122221234
In the first example, the Network Element ID number for a specific telephony controller component is 73. The IP address is 192.11.12.123, and the IP port number is 13. The specific telephony controller component network address is 444411112222.
One ASP ID must appear as the Network Element Instance in components.dat.
For the DAS, the bearChan.dat file defines the mapping between bearer channels implemented on the access server attached to the telephony controller. A bearer channel is uniquely defined by combining the associated signal path with the corresponding bearer channel.
For the virtual switch controller, this information resides in the bearChanSwitched.dat file. The bearChan.dat file still exists, but is empty.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
sigPathID | Hex | 4 | [Primary Key] Signal path identification number. Related file and field: sigPath.dat---sigPathID This indicates the point code of the signaling. |
spanID | Hex |
| Mapped to the sigPathID. See Table A-5. Note Spans on the Cisco SC2200 and access server must match. You must know on which T1 the CIC resides.Value is ffff (and field is unused) if mapping from a telephony controller to a NAS. |
bearChanID | Hex | 8 | Unique Bearer Channel use for mapping within sigPathID. [Primary key] For SS7, this is a bearer channel CIC1 and is expressed in hexadecimal. For ISDN, this is a timeslot. Bearer channel values depend on the signaling path type. For example:
|
mateSigPathID | Hex | 4 | Related file and field: sigPath.dat---sigPathID This indicates the signaling path to the NAS. |
spanID | Hex |
| Mapped to the mateSigPathID. See Table A-5. This indicates the SpanID on the NAS. Note Spans on the Cisco SC2200 and access server must match. You must know on which T1 the CIC resides. |
mateBearChanID | Hex | 8 | Values are the same as bearChanID. |
| 1CIC = circuit identification code 2DPNSS = Digital Private Network Signaling System |
The records in Table A-5 demonstrate the mapping between bearer channels 1, 2, 3 of signal path 1 to the mate bearer channels 1, 2, 3 of signal path 2.
130001 | Span | 01 | 130002 | Span | 01 |
130001 | Span | 02 | 130002 | Span | 02 |
130001 | Span | 03 | 130002 | Span | 03 |
00130002 ffff 0001 00140001 0 0001 00130002 ffff 0002 00140001 0 0002 00130002 ffff 0003 00140001 0 0003 00130002 ffff 0004 00140001 0 0004 00130002 ffff 0005 00140001 0 0005
For added records to be valid in this table, both sigPathID and mateSigPathID must exist in components.dat as instances of the signaling path component type. Records must not be deleted from this file as long as either sigPathID or mateSigPathID are referenced in sigPath.dat.
For the specified mapping to be effective, both sigPathID and mateSigPathID must exist in sigPath.dat.
For the VSC, the bearChanSwitched.dat file defines the mapping of each bearer channel through the VSC. It controls routing for switched calls.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
Component ID of Signal Path | Hex | 8 | The signal path coming into the VSC. |
spanID | Hex | 4 | The spanID of the signal path; for the VSC, the default value is fffff and no other spanID is required. |
DS0/Bearer channel | - | 4 | The bearerID of each bearer coming from the signal path into the switch. |
sigPathID | Hex | 8 | The sigPathID for the SGCP path between the CU1 and the SU2 over IP. |
Span on ATM Switch | - | - | A string created in the configuration tool that identifies:
|
| 1CU = coding unit (for example, an ATM switch). 2SU = signaling unit (for example, the VSC). |
00070001 0 0001 00180001 CBR0.0.3/1@cu02 00070001 0 0002 00180001 CBR0.0.3/2@cu02 00070001 0 0003 00180001 CBR0.0.3/3@cu02 00070001 0 0004 00180001 CBR0.0.3/4@cu02 00070001 0 0005 00180001 CBR0.0.3/5@cu02
For added records to be valid in this table, both the sigPathID and the Span on the ATM switch must exist in components.dat as instances of the signaling path component type. Records must not be deleted from this file as long as either the sigPathID or the Span on the ATM switch are referenced in the sigPath.dat file.
The buckets.dat file defines measurement buckets/intervals with associated thresholds. A bucket is a generic container for storing a measurement and may have up to two thresholds (floor and ceiling) associated with it. If a measurement is being reported on, but no alarm conditions exist for this counter, the threshold field in the record may contain a null string.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
sequenceNum | Integer | 8 | Table index. Needs to be a unique identifier. |
bucketName | Text | 32 | [Primary Key]. The name of this bucket. |
bucketID | Integer | 8 | The numeric identifier of the corresponding record in measProfs.dat. Each measurement in measProfs.dat may have one or more buckets. |
interval | Integer | 8 | Data collection period in seconds, which must be one of the following fixed intervals:
|
thresholdName | String | 80 | [Foreign key] Threshold name. thresholds.dat---thresholdName There may be up to two thresholds per bucket. Use a null string for buckets that have no alarm thresholds associated with them. |
2 b_lifses15 1 900 "T_lifses15" 4 b_lifses60 1 3600 "T_lifses60" 5 b_lifses24 1 86400 "T_lifses24" 7 b_prof_std15 2 900 "" 9 b_prof_std60 2 3600 ""
In the third line, the first field identifies the sequence number (5). The second denotes the bucket name (b_lifeses24). The third shows that the bucket is related to measurement 1 in measCats.dat and the fourth identifies that it has an interval of 24 hours. The final field indicates a threshold defined in quotes as "T_lifeses24". (The thresholds.dat file must contain the definition of this threshold.)
The last record with a given bucketName in this table must not be deleted if any records exist with the same bucket name in the measProfs.dat table.
Any threshold names used in this table must be defined in thresholds.dat for the entry to be valid.
The components.dat file identifies all visible entities within a network element that can be managed by the user, who defines the type of component, the instance for that component type, and the related parent component information. Components are arranged in a hierarchy. The components.dat file shows the component ID for each component in your configuration, and the parent/child relationship of that component.
The components.dat file renames each component in your network. For example, you may have named your SS7 link "SS7 Line In." In components.dat, the software names each component based on the CompID and compName fields in the compTypes.dat file.
All Auxiliary Signal Path (ASP) entries are tagged with a component type of 0x000E. This is identified by the ASP label. A dummy value of 000E0000 is used in this table. This value is never passed to either the channel controller or the engine.
In prior releases, a signal path had a one-to-one relationship with a signal channel. However, for C7 signal paths, up to 16 links (signal channels) can be in a link set (signal path). To expand the relationship, signal channels need to have their own component IDs. Currently, signal channels do not exist as a separable entity. For C7, a signal channel needs to be recognized in compTypes.dat and components.dat.
Table A-8 contains lists and describes the components.dat fields.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
componentID | - | - | [Primary Key] Composed of the following sub-fields compType and compInstance. |
compType | Hex | 4 | Type of component being represented, encoded as a 4-digit hex number. |
compInstance | Hex | 4 | The instance of the component type being represented. This number is significant only within a specific component type. It begins at 1 and goes up to 65535. |
parentCompId | - | - | Key of the parent component. It is used to model a containment relationship between the parent and the current record. The parent must exist before the current record can exist. |
parentCompType | Hex | 4 | Parent component type. See compType description. |
parentCompInst | Hex | 4 | Parent component instance. See compInstance description. |
compInstName | String | 16 | Symbolic name for compInstance. This is used by the MML interface and some processes internally. |
compDescription | String | 80 | A customer-defined description of the component to be used for identification or notes. This is used in MML responses and alarms to indicate which telephony controller component generated the message. |
Table A-9 shows a sample components.dat file. This example includes components found in the components.dat file for both a Cisco SC2200 signaling controller and a Cisco VSC2700 virtual switch controller (release 4.2.12 and higher).
| componentID | parentCompID | compInstName | compDescription |
|---|---|---|---|
00010001 | 0 | LPC-01 | TransPath or VSC* |
00020001 | 00010001 | CFGG-01 | Configuration manager subsystem |
00020002 | 00010001 | ALGG-01 | Alarm manager subsystem |
00020003 | 00010001 | MSGG-01 | Measurement manager subsystem |
00020004 | 00010001 | ENGG-01 | Engine subsystem |
00020005 | 00010001 | IOSG-01 | I/O subsystem |
00020006 | 00010001 | LOGM-01 | Log manager subsystem |
00020007 | 00010001 | XEG-01 | Execution environment daemons |
00020008 | 00010001 | PFMG-01 | Platform monitoring |
00030001 | 00020007 | CFM-01 | Configuration manager |
00030002 | 00020007 | ALM-01 | Alarm manager |
00030003 | 00020007 | MM-01 | Measurement manager |
00030004 | 00020007 | DMPR-01 | Data dumper |
00030005 | 00020008 | DSKM-01 | Disk space monitor |
00030006 | 00020004 | ENG-01 | Engine |
00030007 | 00020005 | IOCM-01 | IOS channel manager |
00030008 | 00020005 | IOCC-ASP | IOS channel controller---ASP |
0003000A | 00020007 | SNMP-AGT | SNMP agent subsystem |
0003000B | 00020005 | IOCC-01 | IOS channel controller---ANSI---SS7 |
0003000C | 00020005 | IOCC-PRIIP | IOS channel controller---PRI-IP |
0003000D | 00020005 | IOCC-IP1 | IOS channel controller---EISUP* |
00040001 | 00010001 | CPU-01 | CPU 1 |
00040003 | 00010001 | DISK-01 | Hard disk 1 |
00040004 | 00010001 | DISK-02 | Hard disk 2 |
00050001 | 00010001 | SS7 in | SS7 in---SS7 LIF |
00050002 | 00010001 | EN-1 | EN-1---Ethernet 1 |
00050003 | 00010001 | EN-2 | EN-2---Ethernet 2 |
00060001 | 00050001 | L-SS7 in-LIF_0 | L-SS7 in LIF_0---SS7 line in |
00060002 | 00050002 | PO1-EN-1 | PO1-EN-1---Interface 1 on Ethernet 1 |
00060003 | 00050003 | PO1-EN-2 | PO1-EN-2---Interface 1 On Ethernet 2 |
00070001 | 00060001 | SC-1 | SC-1---PBX 1* |
00070002 | 00060001 | SC-2 | SC-2---PBX 2* |
00080001 | 00010001 | LS-222 | LS-222---SS7 line traffic Path |
00090001 | 00010001 | CPARM | XECfgParm.dat |
00090002 | 00010001 | TABLE | tables.dat |
00090003 | 00010001 | CTYPE | compTypes.dat |
00090004 | 00010001 | COMP | components.dat |
00090005 | 00010001 | ACAT | alarmCats.dat |
00090006 | 00010001 | DEPND | dependencies.dat |
00090007 | 00010001 | MCAT | measCats.dat |
00090008 | 00010001 | PGRP | procGroups.dat |
00090009 | 00010001 | PROC | processes.dat |
0009000A | 00010001 | SRVC | services.dat |
0009000B | 00010001 | SIGS | sigPath.dat |
0009000C | 00010001 | DPC | dpc.dat |
0009000D | 00010001 | ROUTE | routes.dat |
0009000E | 00010001 | SNMPM | snmpmgr.dat |
000A0001 | 00010001 | ALOG | Alarm log |
000A0002 | 00010001 | CLOG | Command log |
000A0003 | 00010001 | MLOG | Measurement log |
000A0004 | 00010001 | DLOG | Debug log |
000B0001 | 00010001 | PM-01 | Process manager |
000C0001 | 00010001 | MML-01 | MML 1 |
000C0002 | 00010001 | MML-02 | MML 2 |
000C0003 | 00010001 | MML-03 | MML 3 |
000C0004 | 00010001 | MML-04 | MML 4 |
000C0005 | 00010001 | MML-05 | MML 5 |
000C0006 | 00010001 | MML-06 | MML 6 |
000C0007 | 00010001 | MML-07 | MML 7 |
000C0008 | 00010001 | MML-08 | MML 8 |
000C0009 | 00010001 | MML-09 | MML 9 |
000C000A | 00010001 | MML-10 | MML 10 |
000C000B | 00010001 | MML-11 | MML 11 |
000C000C | 00010001 | MML-12 | MML 12 |
0.00E+00 | 00010001 | ASP | ASN connection |
00100001 | 80000001 | DC-222-0 | DC-222-0---SS7 line traffic path |
00100001 | 00070001 | DC-1-0 | DC-1-0---PBX 1* |
00100002 | 00140001 | SC1-003 | Signaling channel 1 for IP SigPath 003 |
00100002 | 00070002 | DC-2-1 | DC-2-1---PBX 2* |
00100003 | 00180001 | SC1-CU1 | SC1-CU1---Signaling channel 1 for SGCP SigPath CU1* |
00100004 | 00180001 | SC2-CU1 | SC2-CU1---Signaling channel 2 for SGCP SigPath CU1* |
00100005 | 00180001 | SC3-CU1 | SC3-CU1---Signaling channel 3 for SGCP SigPath CU1* |
00100006 | 00180001 | SC1-CU2 | SC1-CU2---Signaling channel 1 for SGCP SigPath CU2* |
00100007 | 00180001 | SC2-CU2 | SC2-CU2---Signaling channel 2 for SGCP SigPath CU2* |
00100008 | 00190001 | SC1-VSC1 | SC1-VSC1---Signaling channel 1 for EISUP SigPath VSC1* |
00100009 | 00190001 | SC1-VSC8 | SC1-VSC8---Signaling channel 1 for EISUP sigpath VSC8* |
00110001 | 00010001 | R-0001 | Route 0001 |
00130001 | 00010001 | OPC-0-0-4 | OPC 0.0.4 |
00130002 | 00010001 | PC-0-0-1-2 | Address: 0.0.1, Network Indicator: 2 |
00140001 | 00160001 | SP1-IP | IP Sig Path 003 |
00160001 | 00010001 | CU1 | External Node - CU1 |
00160002 | 00010001 | CU2 | External Node - CU2 |
00170001 | 0003000A | SNMP-MGR-01 | SNMP manager 01 |
00180001 | 00160001 | TP1-CU1 | TP1-CU1---SGCP SigPath |
00180002 | 00160002 | VSC9-CU2 | VSC9-CU2---SGCP SigPath* |
00190001 | 001A0001 | TP1-SU1 | TP1-SU1---EISUP SigPath |
001A0001 | 00010001 | SU1 | External Node---SU1 |
001A0002 | 00010001 | VSC8 | VSC8---External Node VSC8* |
* = Virtual switch controller (VSC)---Release 4.2.12 and higher
C7 has an additional requirement of specifying reachable destination point codes (DPCs). This requires a component type and entries in the components.dat table.
00010001 00000000 "TRANSPATH SYSTEM-02" "DEMOLAB002" 00050001 00010001 "IOC-01" "Line Interface Card 1" 00060001 00050001 "L-01" "Card 1, LIF 1"
In the second line of the above example, a line card component is defined with a component type of 5 and an instance of 1. The card has a symbolic identifier of IOC-01 as indicated by the description. Its parent component is the network element instance 1 of type 1. This entry in the table, type=1 and instance=1 identifies the network element.
The compInstName defines the network element as a whole. In this case, it is called "TRANSPATH SYSTEM-02." The description field is replaced by the customer-defined location. This is generally a unique identifier used in a network to describe a network element based on its location or address plan. The description in the example "DEMOLAB002" indicates it is the second TransPath system element in the demonstration lab.
Both compType and parentCompType must exist in compTypes.dat before a record can be added.
A record cannot be deleted from this table if related records exist (referencing the same component instance or name) in bearChan.dat, bearChanSwitched.dat (for the VSC), sigPath.dat, procGroups.dat, processes.dat, or dependencies.dat.
The compInstName is used as a key for lookups and it must be unique. Component identification numbers must also be unique.
The compTypes.dat file contains an identification number, name, and description for each type of component in the system. Examples of component types include processes, process groups, I/O cards, signaling channels, and thetelephony controller itself. Either the identification number or the name of the component type may be used as a key.
Table A-10 contains the compTypes.dat field formats.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
CompTypeID | Hex | 4 | [Primary Key] Component type identification number. This is the table index. It also is used in components.dat. |
CompTypeName | String | 40 | [Primary Key] Component type name. This is used as a symbolic key to find the compTypeId. |
CompTypeDescription | String | 80 | A compType description, which is used for documentation purposes only. |
The signaling software for the Dial Access Solution (DAS) supports only fully associated links so a signal path is a route to a destination point code (DPC). However, there may be multiple signal paths to that point code.
Table A-11 shows a sample compTypes.dat file.
| Type ID | Type Name | Component Type Description |
|---|---|---|
0001 | LPC | Network element |
0002 | Proc Group | A process group |
0003 | Proc | An individual process |
0004 | Equipment | System hardware |
0005 | IO Card | Line interface card |
0006 | LIF | Transmission line interface |
0007 | Sig Path FAS | Signaling channel---Physical time slot |
0008 | Sig Path C7 | Link Set---C7 |
0009 | Config File | System configuration file |
000A | Log File | System log file |
000B | Proc Mgr | Process manager |
000C | MML | MML process |
000D | Maint Chan | Maintenance channel |
000E | ASP | Auxiliary signaling path |
0010 | Sig Chan | Signal channel---C7 link or ISDN channel |
0011 | Route | C7 route |
0012 | Route Set | C7 route set |
0013 | Point Code | C7 point code |
0015 | Traffic Chan | Bearer channel (not used) |
0016 | External Node | External node |
0017 | SNMP Mgr | SNMP manager |
0014 | Sig Path IP | Signal path using IP delivery |
0018 | Sig Path SGCP | SU-CU sigPath over SGCP |
0019 | Sig Path EISUP | SU-SU sigPath over EISUP1 |
001A | External SU | External SU |
| 1EISUP = extended ISUP |
A record may not be deleted from this table as long as related records (that is, records referencing a certain component type or name) exist in any other table.
The dpc.dat file defines the destination point code (DPC) and the network indicator of the switch supplying the bearer trunks. Each point must have a component ID and a DPC number. The DPC number is encoded according to rules defined by the service provider. For ETSI C7 networks, a supplementary network indicator is required to differentiate customers of Competitive Access Provider (CAP) networks within a single service provider's network.
| Field Name | Data Type | Max Length | Specific Instructions |
|---|---|---|---|
DpcId | Hex | 8 | Component ID is required. |
DpcNum | Point code | 8 | Destination point code number is required. |
NetworkInd | Integer | 1 | The network indicator is defined in order to provide context for the point code. Valid values are as follows: 0 = International network 1 = Reserved 2 = National network 3 = National spare |
These records refer to DPCs in the national network.
00131001 1.1.3 2 00131002 1.1.4 2
The component ID of each record must exist in components.dat.
The dependencies.dat file controls the order in which the process manager starts and stops processes and groups. For example, if you enter a command to start a process and that process is dependent on other processes, the dependent process will not start until the other processes are started. Your command is deferred until the other processes have started.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
DepType | Text | 1 | Specifies that the dependent process, DepName, is either a process or a group. This text character must be one of the following: g = group p = process |
DepName | String | 80 | [Primary Key] components.dat Name of the process or process group that is dependent on another process or process group. |
DepcyType | Text | 1 | Specifies that the dependent process, DepName, is dependent on either a process or a process group. This text character must be one of the following: g = group p = process |
DepcyName | String | 80 | [Foreign Key] components.dat Name of the target process or process group upon which the dependent process, DepName, depends. |
g "IOSG-01" g "ENGG-01" p "IOCM-01" g "XEG-01" p "IOCC-01" p "IOCM-01"
In the first line of example, the process manager does not start the process group named OSG-01 until after the process group named ENGG-01 has been started.
All process or process groups referred to in this file must already exist in processes.dat or procGroups.dat. Both must also exist in components.dat.
The dialplan.dat file is used in the VSC configuration for telephony controller software release 4.2.12 and higher. It contains a list of valid route names and component IDs that have been configured on the VSC. When the routes are configured using the dial plan provisioning (DPP) tool, the route names from this file are entered. When the dial plan is loaded onto the VSC, the dialplan.dat file replaces the route names with the correct component IDs. This allows the same route name to be configured for different VSCs in the configuration tool. When the dialplan.dat file is moved onto the VSC, the correct component IDs are associated with the dial plan files.
See the Cisco VSC2700 Virtual Switch Controller Dial Plan Provisioning Guide (OL-0128-xx) for more information about the DPP.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
Component ID | String | 8 | Component ID on the VSC. |
Signal Path | Text | 10 | Signal path from the VSC to the destination. |
00070001 "SC-11" 00070002 "SC-4" 00070003 "SC-10" 00070004 "SC-3" 00190001 "tp02-tp01"
The component IDs in the dialplan.dat file must exist in the components.dat file.
The telephony controller's data dumper collects records, such as call detail records (CDRs), statistics, and alarms, in the /opt/TransPath/var/log area and stores them locally in the /opt/TransPath/var/spool directory. Other processes or systems then retrieve the record logs. Table A-15 shows the dmprSink.dat field formats.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
sinkID | Integer | 8 | Table index. |
sinkName | String | 80 | [Primary Key] This identifies the type of records to be collected. Valid values are: callDetail = call detail records measReport = measurement records almState = alarm records |
sinkFmt | Text | 3 | Output file format. The value must be one of the following: csv = comma-separated value bin = binary |
sinkPrefix | String | 3 | Files will be created with this prefix for the file name. |
openSinkDir | String | 80 | Destination directory for active files, which are those that are open and being updated. |
closeSinkDir | String | 80 | Destination directory for completed files after they have been closed. |
maxRecs | Integer | 4 | This is the maximum number of records a file is allowed to contain before it is closed. If this is zero, then there is no maximum. |
maxSize | Integer | 8 | This is the maximum size that a file is allowed to grow to, in kilobytes. If this is zero, then there is no maximum. |
maxTime | Integer | 8 | This is the maximum number of minutes a file is allowed to remain open. If this is zero, then there is no maximum. |
1 "callDetail" csv "CDR" "../log" "../spool" 1500 0 15
The example shows that the sinkName is callDetail; the sink format is a comma-separated value. The maximum number of records allowed for the file is 1500. There is no maximum file size and the file can remain open for up to 15 minutes. The above is a relative path name.
Empty files remain open until data is written to them, even if the time limit is exceeded.
The format of records in the capture files is specific to each record type and format. (See "Retrieving Call Detail Records and Network Measurements," for more information.)
The measCats.dat file defines measurement categories for the system. A measurement (or counter) is uniquely defined by its measurement category identification number. This file includes the measurement category name, units of measure, and associated measurement profile.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
measCategoryID | Integer | 8 | Measurement category ID; table index. |
measCategoryName | String | 255 | [Primary Key] Measurement category name. |
profileName | Text | 80 | [Foreign Key] Profile name. Related file and field: measProfs.dat---profileName |
measUnits | String | 80 | Text indicating units of measurement. |
measCatDesc | String | 80 | Measurement category description. |
001 "LIF: SES" lifses "occurrences" "Line Interface: Severely Errored Seconds" 002 "SC: XMIT FRM TOT" chX_tot "frames" "Sigchan: frames transmitted total" 003 "SC: RCV FRM TOT" chR_tot "frames" "Sigchan: frames received total"
The first line of the example creates a measurement category identified by the short name of LIF: SES. It points to records in measProfs.dat labeled with lifses. The units are called occurrences. Finally, the description gives more information about the measurement.
Records in this table must not be deleted if the profile name is still in use in the measProfs.dat table.
The measProfs.dat table defines the profile associated with a particular measurement category. A profile contains information concerning time intervals for reporting measurements. A profile may have many measurement intervals associated with it, but it must have at least one to enable reporting for that profile. The convention is to collect each measurement on 15-minute, 60-minute, and 24-hour intervals, so that each measurement defined in measCats.dat will have three entries in measProfs.dat.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
sequenceNum | Integer | 8 | Table index, needs to be unique, but otherwise has no significance. |
profileName | Text | 32 | [Primary Key] Profile name. Related file and field: measCats.data---profileName |
profileID | Integer | 8 | The identification number associated with this profile. This includes all occurrences of a given profile name in this file. |
bucketName | Text | 32 | [Foreign key] Related file and field: buckets.dat---bucketName |
This example shows the measurement profiles for a single measurement category. The category is lifses; it is record number 1 in measCats.dat. It has 3 buckets as identified by the b_ convention, for 15 minutes, 60 minutes, and 24 hours. For more information on buckets, refer to the "buckets.datBuckets Definition" section .
001 lifses 1 b_lifses15 002 lifses 1 b_lifses60 003 lifses 1 b_lifses24
Records must not be removed from this table, because they may be in use by programs. Any bucket names used in this table must already exist in buckets.dat file.
The physLineIf.dat table defines line characteristics used by the I/O subsystem to configure cards. The device for the card and the line will be synchronized based on the card type, card slot, and line interface identified in the table.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
lineCompId | Hex | 8 | [Primary Key]Line component ID. Composed of the lineCompType and lineCompInstance subfields. |
lineCompType | Hex | 4 | Type of line component being represented encoded as a 4-digit hex number. |
lineCompInstance | Hex | 4 | Instance of the line component type being represented. This number is significant only within a specific component type. |
cardSlot | Integer | 1 | Unique integer identifying the backplane slot starting from 0. |
cardLIF | Integer | 1 | Line interface on card. Range is 1 - 4. |
cardType | Text | 4 | Identifies the type of card in use. Valid values are: ITK---ITK T1/E1. PTI_V35---Used in the SS7 NTT protocol. ENET---Ethernet card for link used to carry signaling to the NAS. |
signalType | Text | 4 | Signal type. Valid values are: T1---ANSI standard Digital Signal 1 T1 CEPT---European E1 V.35---64 kbps digital |
distVal | Integer | 8 | This is the distance in feet, and is used only for impedance calculations on T1 lines. For other types of lines, this field should be set to Zero (0). |
format | Text | 4 | Line format. Valid values are: NA = not applicable ESF = extended super frame format (T1 only) D4 = super frame (T1 only) CRC4 = E1 |
lineCoding | Text | 4 | Valid values are: NA = not applicable AMI = alternate mark inversion (T1 only) B8ZS = bit stuffing for clear channel (T1 only) HDB3 = E1 |
cardSpecs | Text | 8 | Valid values are: Default = standard NTT = specific Japanese variant for timers Reserved for future use |
In this example, the line component ID number is 00060001. The card is in slot number 1 with a line interface of 1. It is a CEPT-E1 signal type and the distance value is zero (0) because this is not a T1 line. It is formatted for CRC4-E1 and coded for HDB3. The cardSpecs is set to the standard default.
00060001 1 1 ITK CEPT 0 CRC4 HDB3 DEFAULT
For cards that do not require line format, the lineCoding value can be set to NA.
The processes.dat file contains information about every process that the software is responsible for monitoring. Additionally, the processes.dat file holds information related to how often to check the health of a process and about how to restart it.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
procName | String | 80 | [Primary Key] Process name.Related fields and columns: dependencies.dat-depName or depcyName |
procType | Text | 1 | Process type. Valid characters: a = active p = passive m = monitored See Table A-20 for more information. |
procGroup | String | 80 | Group to which the process (procName) belongs. Related fields and columns: procGroups.dat, groupName components.dat, compInstName dependencies.dat, depName or depcyName |
almCategoryName | String | 80 | Related file and field: alarmCats.dat-alarmCategoryName |
componentID |
|
| Composed of the following sub-fields compType and compInstance. For monitored processes, the component ID is used to label the alarms for this process. For active or passive processes, alarms are always ignored. |
compType | hex | 4 | Related files and fields: compTypes.dat-compTypeID components.dat-compType |
compInstance | Hex | 4 | Related files and fields: components.dat-compInstance |
initState | Text | 1 | Defines the desired initial state of this process - It must be one of the following: r = running l = locked c = cutover |
chkInterval | Integer | 8 | Health Check Interval determines the following, based on the process type: Active Processes---How often to confirm existence by the O/S and a positive confirmation from IPC heart-beat. Passive Processes---How often to confirm existence by the O/S. Monitored Processes---How often to run the monitoring script or executable. |
chkTimeout | Integer | 8 | Period to wait (in seconds) after health check before beginning error handling and restart procedures. |
killGrace | Integer | 8 | For a forced exit, this specifies how long to wait (in seconds) after sending a termination signal before sending a kill signal. |
autoStart | Text | 1 | Determines if a process starts up automatically when the process manager starts up or if the process starts only on explicit command. Valid values are: Y = Start process automatically by process manager when process manager starts up. N = Start process only on explicit command. |
| Integer | 8 | The amount of time after the process manager starts up to delay the startup of a process: If = zero, always start when the process manager starts If > zero, delay restart for that period of time. Cannot be < 0. |
maxRestarts | Integer | 8 | The number of times within restart period to attempt restarting this process: If = zero, never If < zero, always If > zero, restart that number of times during restart period |
rstrtPeriod | Integer | 8 | If > zero, number of seconds in the restart period for this process. For example, the process won't be restarted after maxRestarts, if it is still within the restart period. If = zero, process always restarts |
rstrtDelay | Integer | 8 | Number of seconds to wait after a startup failure before attempting to restart; can = zero. |
rstrtDecay | Integer | 8 | Number of seconds to add to rstrtDelay after each restart; can = zero |
cmdLine | String | 80 | Command line (with arguments) used to start this process. |
SNMP-01 |
|
| SNMP Agent. For example, 0003000E is a valid value. |
MOOS |
|
| Manual out-of-service alarm category to signal for this process. There are three Alarm categories for this alarm:
|
Table A-20 shows the 3 monitoring levels that are supported in the procType field.
| Level | Description |
|---|---|
a | Active process---Process identified in the record that is controlled and monitored directly by the process manager. |
p | Passive process--- Process identified in the record that does not communicate with the process manager. |
m | Monitoring process---Periodically runs an executable file or script and sets or clears an alarm, based on the return code. This type of process may monitor other processes or tasks that can be checked programmatically. Examples include:
|
This example shows five active processes (configuration manager, alarm manager, measurements manager, data dumper, and engine). The process group to which each process belongs appear after the process type indicator (a or p). All processes are reporting manual out-of-service alarms.
"CFM-01 " a "XEG-01 " "SOFTW REQ " "MAJOR M-OOS" 00000000 r 30 5 10 Y 0 4 120 5 5 "../bin/cfgM""ALM-01 " a "XEG-01 " "SOFTW REQ " "MAJOR M-OOS" 00000000 r 30 5 10 Y 0 4 120 5 5 "../bin/almM""MM-01 " a "XEG-01 " "SOFTW REQ " "MAJOR M-OOS" 00000000 r 30 10 10 Y 0 4 120 5 5 "../bin/measMgr""DMPR-01 " a "XEG-01 " "SOFTW REQ " "MAJOR M-OOS" 00000000 r 30 5 10 Y 0 4 120 5 5 "../bin/dmpr""ENG-01 " a "ENGG-01 " "SOFTW REQ " "MAJOR M-OOS" 00000000 r 20 19 20 Y 0 4 120 5 5 "../bin/engine"
Before adding records to this table, verify the following:
The procGroups.dat file contains an entry for each managed process group on the system. Information is included indicating whether the process manager must automatically start this group and what delay must be involved.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
groupName | String | 80 | [Primary Key] Process group name. Related files and fields: components.dat-compInstName dependencies.dat-depName or depcyName |
autoStart | Text | 1 | Determines if a process group starts automatically when the process manager starts or if the process starts only on explicit command. Text character must be one of the following: Y = Start the process group when the process manager starts. N = Start the process group only on an explicit command. |
autoDelay | Integer | 8 | Enter the amount of time, in seconds, to delay automatic startup. If this is set to zero (0), the process manager starts the process group as soon as possible. |
This example defines three of the many process groups in the system. When the process manager comes up, it will automatically start these process groups without delay.
"XEG-01" Y 0 "ENGG-01" Y 0 "IOSG-01" Y 0
Records must exist for this process group in the components.dat table before this record may be used. Records must not be deleted from this table if they are referenced in the dependencies.dat table.
The properties.dat file defines values for configurable entities within the telephony controller. These entities may be equipment, circuits, protocols, or software. The data in this file pertains to both the I/O subsystem and the engine subsystem.
Table A-22 lists the possible properties, ranges, and default values for a properties.dat file. Depending on your configuration, all of the properties listed here may not be present in your properties.dat file.
| Property | Range | Default |
|---|---|---|
*.A/Bflag | A or B | A |
*.ASP_part | Y or N | Y---signaling controller N---virtual switch controller |
*.BcInitState | IS or OOS | IS |
*.BOrigStartIndex | 0 to 1 | 0 |
*.BothwayWorking | 0 to 1 | 1 |
*.BTermStartIndex | 0 to 2 | 0 |
*.CGBA2 | 0 to 1 | 0 |
*.CLIPEss | 0 to 1 | 0 |
*.CotInTone | Hz | 2010 |
*.CotListenDuration |
| 60 |
*.CotOutTone | Hz | 2010 |
*.CotPercentage | 0 to 100% | 10 |
*.CotPlayDuration |
| 60 |
*.cr_len |
| 2 |
*.ExtCOT |
| Loop |
*.ForwardCLIinIAM | 0 to 1 | 0 |
*.ForwardSegmentedNEED |
| 1 |
*.GLARE | 0 to 3 | 0 |
*.GRA2 | 0 to 1 | 0 |
*.GRSEnabled | True or False | False |
*.InternationalPrefix | Numerical string | 00 |
*.lapd_kval |
| 7 |
*.lapd_n200 |
| 10 |
*.lapd_n201 |
| 260 |
*.lapd_t200 |
| 10 |
*.lapd_t203 |
| 500 |
*.NationalPrefix | Numerical string | 0 |
*.Normalization | 0 to 1 | 0 |
*.OMaxDigits | 0 to N | 24 |
*.OMinDigits | 0 to N | 0 |
*.OOverlap | 0 to N | 0 |
*.OverlapDigitTimeValue | 6 to 60 seconds | 6 |
*.PropagateSvcMsgBlock | True or False | False |
*.RedirMax |
| 3 |
*.rudp_ack |
| Disable |
*.rudp_keepalives |
| Disable |
*.rudp_num_retx |
| 3 |
*.rudp_retx_timer |
| 3 |
*.rudp_sdm |
| Disable |
*.rudp_window_sz |
| 8 |
*.sgcp_retx_count |
| 3 |
*.sgcp_retx_timer |
| 20 |
*.side |
| User |
*.span_id |
| 0 |
*.su_role |
| 0 |
*.SuppressCLIDigits | 0 to 1 | 0 |
*.TMaxDigits | 0 to N | 24 |
*.TMinDigits | 0 to N | 0 |
*.TOverlap | 0 to 1 | 0 |
*.VNETid |
|
|
BTNUP.lssu_len | 1 to 2 | 2 |
BTNUP.max_align_tries |
| 5 |
BTNUP.max_msu_frm_len |
| 272 |
BTNUP.max_slt_tries |
| 2 |
BTNUP.mtp2_aerm_emg_thr | 1 to 4 seconds | 1 |
BTNUP.mtp2_aerm_nrm_thr | 1 to 6 seconds | 4 |
BTNUP.mtp2_max_outs_frames |
| 8 |
BTNUP.mtp2_suerm_thr | 32 to 64 seconds | 64 |
BTNUP.mtp2_t1 |
| 450 |
BTNUP.mtp2_t2 |
| 250 |
BTNUP.mtp2_t3 |
| 20 |
BTNUP.mtp2_t5 | 0.8 to 01.2 seconds | 1 |
BTNUP.mtp2_t6 | 1 to 60 seconds | 60 |
BTNUP.mtp2_t7 | 0.5 to 20 seconds | 10 |
BTNUP.mtp3_t12 | 1 to 15 seconds | 10 |
BTNUP.mtp3_t13 | 1 to 15 seconds | 10 |
BTNUP.mtp3_t14 | 20 to 30 seconds | 20 |
BTNUP.mtp3_t20 | 90 to 600 seconds | 600 |
BTNUP.mtp3_t21 |
| 640 |
BTNUP.mtp3_t22 |
| 3000 |
BTNUP.mtp3_t7 | 1 to 20 seconds | 20 |
BTNUP.proving_emg_t4 | 5 to 7 seconds | 6 |
BTNUP.proving_normal_t4 |
| 95 |
BTNUP.reference | ITU92 | ITU92 |
BTNUP.sltm_t1 |
| 50 |
BTNUP.sltm_t2 | 150 to 450 | 300 |
RLM.link_echo_retry |
| 3 |
RLM.link_latency_test |
| 600 |
RLM.link_open_wait |
| 30 |
RLM.link_recovery |
| 120 |
RLM.link_switch |
| 50 |
RLM.link_up_recovered_min |
| 600 |
RLM.port |
| 3000 |
RLM.PropagateSvcMsgBlock | True or False | False |
RLM.timer_cmd_ack |
| 10 |
RLM.timer_link_down_min |
| 100 |
RLM.timer_link_echo |
| 10 |
RLM.unstable_link |
| 10 |
SS7-ANSI. CLIDefaultAllowed | True or False | False |
SS7-ANSI.COLDefaultAllowed | True or False | False |
SS7-ANSI.lssu_len | 1 to 2 | 1 |
SS7-ANSI.max_align_tries |
| 5 |
SS7-ANSI.max_msu_frm_len |
| 272 |
SS7-ANSI.max_slt_tries |
| 2 |
SS7-ANSI.msg_priority | 1 to 4 | 2 |
SS7-ANSI.mtp2_aerm_emg_thr |
| 1 |
SS7-ANSI.mtp2_aerm_nrm_thr | 1 to 6 seconds | 4 |
SS7-ANSI.mtp2_max_outs_frames | 8 | 8 |
SS7-ANSI.mtp2_suerm_thr | 32 to 64 seconds | 64 |
SS7-ANSI.mtp2_t1 |
| 130 |
SS7-ANSI.mtp2_t2 |
| 115 |
SS7-ANSI.mtp2_t3 |
| 115 |
SS7-ANSI.mtp2_t5 |
| 1 |
SS7-ANSI.mtp2_t6 |
| 30 |
SS7-ANSI.mtp2_t7 |
| 10 |
SS7-ANSI.mtp3_t12 |
| 10 |
SS7-ANSI.mtp3_t13 |
| 10 |
SS7-ANSI.mtp3_t14 |
| 20 |
SS7-ANSI.mtp3_t20 |
| 900 |
SS7-ANSI.mtp3_t24 | 59 to 61 | 60 |
SS7-ANSI.mtp3_t26 | 12 to 15 seconds | 15 |
SS7-ANSI.mtp3_t28 |
| 10 |
SS7-ANSI.mtp3_t29 | 60 to 65 seconds | 60 |
SS7-ANSI.mtp3_t7 |
| 10 |
SS7-ANSI.proving_emg_t4 |
| 6 |
SS7-ANSI.proving_normal_t4 |
| 23 |
SS7-ANSI.reference | ANSI92 | ANSI92 |
SS7-ANSI.sltm_t1 | 4 to 12 seconds | 6 |
SS7-ANSI.sltm_t2 |
| 60 |
SS7-China.lssu_len | 1 to 2 | 1 |
SS7-China.max_align_tries |
| 5 |
SS7-China.max_msu_frm_len |
| 272 |
SS7-China.max_slt_tries |
| 2 |
SS7-China.mtp2_aerm_emg_thr |
| 1 |
SS7-China.mtp2_aerm_nrm_thr |
| 4 |
SS7-China.mtp2_max_outs_frames |
| 8 |
SS7-China.mtp2_suerm_thr |
| 64 |
SS7-China.mtp2_t1 |
| 450 |
SS7-China.mtp2_t2 |
| 250 |
SS7-China.mtp2_t3 |
| 20 |
SS7-China.mtp2_t5 |
| 1 |
SS7-China.mtp2_t6 |
| 60 |
SS7-China.mtp2_t7 |
| 10 |
SS7-China.mtp3_t12 |
| 10 |
SS7-China.mtp3_t13 |
| 10 |
SS7-China.mtp3_t14 |
| 20 |
SS7-China.mtp3_t20 |
| 600 |
SS7-China.mtp3_t21 |
| 640 |
SS7-China.mtp3_t22 |
| 3000 |
SS7-China.mtp3_t7 |
| 20 |
SS7-China.proving_emg_t4 |
| 6 |
SS7-China.proving_normal_t4 |
| 95 |
SS7-China.reference |
| ITU92 |
SS7-China.sltm_t1 |
| 50 |
SS7-China.sltm_t2 |
| 300 |
SS7-ITU.CLIDefaultAllowed | True or False | False |
SS7-ITU.COLDefaultAllowed | True or False | False |
SS7-ITU.lssu_len |
| 1 |
SS7-ITU.max_align_tries |
| 5 |
SS7-ITU.max_msu_frm_len |
| 272 |
SS7-ITU.max_slt_tries |
| 2 |
SS7-ITU.mtp2_aerm_emg_thr |
| 1 |
SS7-ITU.mtp2_aerm_nrm_thr |
| 4 |
SS7-ITU.mtp2_max_outs_frames |
| 8 |
SS7-ITU.mtp2_suerm_thr |
| 64 |
SS7-ITU.mtp2_t1 |
| 450 |
SS7-ITU.mtp2_t2 |
| 250 |
SS7-ITU.mtp2_t3 |
| 20 |
SS7-ITU.mtp2_t5 |
| 1 |
SS7-ITU.mtp2_t6 |
| 60 |
SS7-ITU.mtp2_t7 |
| 10 |
SS7-ITU.mtp3_t12 |
| 10 |
SS7-ITU.mtp3_t13 |
| 10 |
SS7-ITU.mtp3_t14 |
| 20 |
SS7-ITU.mtp3_t20 |
| 600 |
SS7-ITU.mtp3_t21 |
| 640 |
SS7-ITU.mtp3_t22 |
| 3000 |
SS7-ITU.mtp3_t7 |
| 20 |
SS7-ITU.proving_emg_t4 |
| 6 |
SS7-ITU.proving_normal_t4 |
| 95 |
SS7-ITU.reference |
| ITU92 |
SS7-ITU.sltm_t1 |
| 50 |
SS7-ITU.sltm_t2 |
| 300 |
SS7-NTT.lssu_len |
| 1 |
SS7-NTT.max_align_ties |
| 5 |
SS7-NTT.max_msu_frm_len |
| 272 |
SS7-NTT.max_slt_tries |
| 0 |
SS7-NTT.mtp2_aerm_emg_thr |
| 1 |
SS7-NTT.mtp2_aerm_nrm_thr |
| 4 |
SS7-NTT.mtp2_max_outs_frames |
| 40 |
SS7-NTT.mtp2_suerm_thr |
| 16384 |
SS7-NTT.mtp2_t1 |
| 150 |
SS7-NTT.mtp2_t2 |
| 50 |
SS7-NTT.mtp2_t3 |
| 30 |
SS7-NTT.mtp2_t5 |
| 2 |
SS7-NTT.mtp2_t6 |
| 30 |
SS7-NTT.mtp2_t7 |
| 20 |
SS7-NTT.mtp2_ta |
| 24 milliseconds |
SS7-NTT.mtp2_te |
| 24 milliseconds |
SS7-NTT.mtp2_tf |
| 24 milliseconds |
SS7-NTT.mtp2_tfv |
| 24 milliseconds |
SS7-NTT.mtp2_to |
| 24 milliseconds |
SS7-NTT.mtp2_ts |
| 24 milliseconds |
SS7-NTT.mtp2_tso |
| 24 milliseconds |
SS7-NTT.mtp3_apc_mtp_rstrt_t21 |
| 0 |
SS7-NTT.mtp3_clear_tfc |
| 200 |
SS7-NTT.mtp3_dlnk_conn_ack_t7 |
| 20 |
SS7-NTT.mtp3_frc_unh_t13 |
| 0 |
SS7-NTT.mtp3_inh_ack_t14 |
| 0 |
SS7-NTT.mtp3_loc_inh_tst_t22 |
| 0 |
SS7-NTT.mtp3_max_slt_tries |
| 0 |
SS7-NTT.mtp3_mtp_rstrt_t20 |
| 0 |
SS7-NTT.mtp3_t12 |
| 0 |
SS7-NTT.mtp3_t13 |
| 0 |
SS7-NTT.mtp3_t14 |
| 0 |
SS7-NTT.mtp3_t20 |
| 0 |
SS7-NTT.mtp3_t21 |
| 0 |
SS7-NTT.mtp3_t22 |
| 0 |
SS7-NTT.mtp3_t7 |
| 20 |
SS7-NTT.mtp3_tc |
| 200 |
SS7-NTT.mtp3_TFRused |
| 1 |
SS7-NTT.mtp3_unh_ack_t12 |
| 0 |
SS7-NTT.mtp3tst_sltm_t1 |
| 0 |
SS7-NTT.mtp3tst_sltm_t2 |
| 0 |
SS7-NTT.mtp3tst_srta_t10 |
| 50 |
SS7-NTT.proving_emg_t4 |
| 30 |
SS7-NTT.proving_normal_t4 |
| 30 |
SS7-NTT.reference |
| NTT |
SS7-NTT.sltm_t1 |
| 0 |
SS7-NTT.sltm_t2 |
| 0 |
SS7-NTT.srta_t10 |
| 50 |
Table A-23 displays the definition of each property.
| Property | Definition |
|---|---|
*.BcInitState | Indicates to signaling node whether the default service state of bearer channels should be in-service (IS) or out-of-service OOS when the destination is available. Only set to OOS for specific signaling systems that perform bearer channel negotiation. |
A/Bflag | Sets either A or B side for DPNSS link. Ignored by non-DPNSS protocols. |
ASP_part | Determines whether a destination will attempt to take advantage of Feature Transparency signaling. Set for each traffic path in the telephony controller. |
BOrigStartIndex | Specifies the starting number analysis digit index for call originations. |
BothwayWorking | Set to 0 to disable both way release / circuit free handling for BTNUP protocol. |
BTermStartIndex | Specifies the starting number analysis digit index for call terminations. |
CGBA2 | Determines whether paired 0 or single 1 circuit group blocking acknowledgments CGBA are required before the blocking will be considered successful. Only applicable to ANSI SS7, IBN7, and CTUP protocols. |
CLIPEss | Set to 1 to force request of Calling Line Identity CLI if not automatically provided. |
CotInTone | Receive Tone for COT Hardware. |
CotListenDuration |
|
CotOutTone | Transmit Tone for COT Hardware. |
CotPercentage | Statistical COT Test. |
CotPlayDuration |
|
cr_len | Length of Q.931 call reference field. Set for each traffic path in the telephony controller. |
ExtCOT | Set to Loop to enable COT handling for the specified destination. |
ForwardCLIinIAM | Set to 1 if outgoing IAM should contain the Calling Line Identity, if available. Only applicable for BTNUP when interworking from other protocols. |
ForwardSegmentedNEED | Set to 0 to disable the forwarding of segmented NEED messages within the BTNUP_NRC protocol. If segmenting is disabled, all mandatory DPNSS information elements will be packed into a single BTNUP NEED message. |
GLARE | Call Collision Handling. Valid values are: 0 = No glare handling; also known as yield to all double seizures. Call collision results in a REL sent to both calls. Note Note: Both ends of a link can be given this option. It is also the default.1 = Has control; the telephony controller specified with this option controls all circuits and any call collisions are handled by this telephony controller, ignoring the conflicting received IAMs and proceeding with its own calls as normal. Note Note: Only one end of a link can be designated with this option.2 = Highest point code controls even circuits. Depending on the OPC of the telephony controllers, the side that has the higher point code will control the even circuits, while the side with the lower point code will control the odd circuits. Note Note: Both ends of a link can be given this option.3: No control. The telephony controller specified with this option does not control any circuits. Any call collision is handled by this telephony controller ignoring its IAM and accepting the IAM from the side with control. Note This option is usually used in conjunction with the remote node designated with control. |
GRA2 | Determines whether paired 0 or single 1 group reset acknowledgments (GRAs) are required before the reset will be considered successful. Only applicable to ANSI SS7, IBN7, and CTUP protocols. |
GRSEnabled | This property is assigned to an SS7 point code signal path. Enables group reset and blocking procedure at point code initialization. Synchronizes telephony controller's view of bearer channel blocking state with that of end office. If True, GRS messages are sent for all CICs associated with the point code. If False, GRS messages are not sent. |
InternationalPrefix | International prefix string to be added to the international dialed number when normalization is enabled. |
lapd_kval | In reference to Q.921, represents the maximum number of outstanding I frames. |
lapd_n200 | In reference to Q.921, represents the maximum number of retransmissions of I frames. |
lapd_n201 | In reference to Q.921, represents the maximum length of the I frame information field. |
lapd_t200 | In reference to Q.921, represents the retransmission timer. |
lapd_t203 | In reference to Q.921, represents the inactivity timer. |
lssu_len | Link status signal unit, status field length. |
max_align_tries | Number of attempts to align link. |
max_msu_frm_len | Maximum length of a C7 message signal unit. |
max_slt_tries | Maximum retries of signal link test message. |
msg_priority | Message priority of management messages for congestion periods. Priority 1 is the highest priority. |
mtp2_aerm_emg_thr | Signal unit error threshold during emergency operation. |
mtp2_aerm_nrm_thr | Signal unit error threshold during normal operation. |
mtp2_max_outs_frames | The maximum outstanding frames that can be sent without receiving acknowledgment. |
mtp2_suerm_thr | Signal unit error threshold during emergency operation. |
mtp2_t1 | Maximum period in aligned/ready state before return to out-of-service state. |
mtp2_t2 | Maximum period in not aligned state before return to out-of-service state. |
mtp2_t3 | Maximum period in aligned state before return to out-of-service state. |
mtp2_t5 | Period for sending a SIB1 message to the far-end. |
mtp2_t6 | Remote congestion timer. If congestion is not cleared before expiration of this timer, the link fails. |
mtp2_t7 | Mtp2 acknowledgment timer. On expiration, the link fails and an "excessive delay of acknowledgment" management message is generated. |
mtp2_ta | SIE transmission interval. |
mtp2_te | SU normalization time. |
mtp2_tf | FISU transmission interval. |
mtp2_tfv | FISU transmission interval during verification. |
mtp2_to | SIO transmission interval. |
mtp2_ts | SIOS transmission interval. |
mtp2_tso | SIOS transmission duration when out-of-service. |
mtp3_apc_mtp_rstrt_t21 |
|
mtp3_clear_tfc |
|
mtp3_dlnk_conn_ack_t7 |
|
mtp3_frc_unh_t13 |
|
mtp3_inh_ack_t14 |
|
mtp3_loc_inh_tst_t22 |
|
mtp3_max_slt_tries | Maximum retries of signal link test message. |
mtp3_mtp_rstrt_t20 |
|
mtp3_t12 | Waiting for uninhibited acknowledgment. |
mtp3_t13 | Waiting for force uninhibited. |
mtp3_t14 | Waiting for inhibit acknowledgment. |
mtp3_t20 | Local inhibit test timer. |
mtp3_t21 | Local inhibit test timer. |
mtp3_t22 | Traffic restart waiting message at local MTP restart. |
mtp3_t24 | Overall MTP restart timer for local MTP restart. |
mtp3_t26 | Traffic restart waiting message at local MTP restart. |
mtp3_t28 | Overall restart timer for signaling point adjacent to one whose MTP restarts. |
mtp3_t29 | Timer started when traffic restart allowed is sent in response to unexpected traffic restart allowed or traffic restart waiting. |
mtp3_t7 | Waiting for signaling datalink connection acknowledgment. |
mtp3_tc | Route set congestion test timer. |
mtp3_TFRused |
|
mtp3_unh_ack_t12 |
|
mtp3tst_sltm_t1 | Waiting for signaling link test acknowledgment message. This must be greater than the value in mtp2_t6. |
mtp3tst_sltm_t2 | Interval for sending Signaling Link Test message. |
mtp3tst_srta_t10 |
|
NationalPrefix | National prefix string to be added to the national dialed number when mormalization is enabled. |
Normalization | Normalization of dialed number to unknown. Set to 0 for disabled and 1 for enabled. |
OMaxDigits | Specifies maximum number of digits to receive for overlap digit processing for call origination from this traffic path. |
OMinDigits | Specifies minimum number of digits to receive for overlap digit processing for call origination from this traffic path. |
OOverlap | Set to 1 to enable overlap signaling for call origination from this traffic path. |
OverlapDigitTimeValue | Overlap inter-digit timer. Note If OverlapDigitTimeValue timer is set to more than 30 seconds, other timers expire before this timer. |
PropagateSvcMsgBlock | A service state change on a bearer channel that is communicated to the bearer's rate. This property is assigned to an ISDN-PRI type signal path. If true, when a service message indicating a bearer channel should be set out-of-service is received, it is propagated as a BLO2 to the mated SS7 CIC3. A service message indicating that the bearer channel is in-service is propagated as a UBL4 to the mated CIC. |
proving_emg_t4 | Emergency proving period. |
proving_normal_t4 | Normal proving period. |
RedirMax | Specifies the maximum allowable value of the redirection counter parameter available in some C7 signaling systems before call will be force-released. Used to prevent routing loops in certain applications. |
reference | Specifies the ITU or ANSI C7/SS7 version supported. |
RLM.link_echo_retry |
|
RLM.link_latency_test |
|
RLM.link_open_wait |
|
RLM.link_recovery |
|
RLM.link_switch |
|
RLM.link_up_recovered_min |
|
RLM.port |
|
RLM.PropagateSvcMsgBlock |
|
RLM.timer_cmd_ack |
|
RLM.timer_link_down_min |
|
RLM.timer_link_echo |
|
RLM.unstable_link |
|
rudp_ack |
|
rudp_keepalives |
|
rudp_num_retx |
|
rudp_retx_timer |
|
rudp_sdm |
|
rudp_window_sz |
|
sgcp_retx_count |
|
sgcp_retx_timer |
|
side |
|
sltm_t1 | Waiting for signaling link test acknowledgment message. This must be greater than the value in mtp2_t6. |
sltm_t2 | Interval for sending Signaling Link Test message. |
span_id | Set for each traffic path in the telephony controller. |
srta_t10 | Signaling route test acknowledgment wait timer |
su_role |
|
SuppressCLIDigits | If this property is set when calling party number is present and presentation is set to restricted, the calling party number parameter is sent, but there are no digits. Set to 0 for False and 1 for True. |
TMaxDigits | Specifies maximum number of digits to receive for overlap digit processing for call termination to this traffic path. |
TMinDigits | Specifies minimum number of digits to receive for overlap digit processing for call termination to this traffic path. |
TOverlap | Set to 1 to enable overlap signaling for call termination to this traffic path. |
VNETid | Four-character alphanumeric specifying which customer ID this traffic path is associated with. Set to 0000 to disable VNETId facilities. |
| 1SIB = Status indication busy 2BLO = block 3CIC = circuit identification code 4UBL = unblock |
The routes.dat file defines all routes used for connecting to destination point codes (DPCs) in a C7 network.
| Field Name | Description | Special Instructions |
|---|---|---|
Route CompId | C7 route ID. |
|
DPC CompId | Destination point code (DPC). |
|
sigPath CompId | Linkset component ID. |
|
OPC CompId | Origination point code (OPC) ID. | This must be the same for all routes. |
OPC Num | Origination point code number. | This is the network-recognized ID for the telephony controller. |
APC Num | Adjacent point code number. | This is the network-recognized ID for the next hop in a route. For fully associated points, this is the DPC. |
Prio | This is the priority of the route to the DPC. |
|
| Route CompId | DPC CompId | Sig Path CompId | OPC CompId | OPC Num | APC Num | Prio |
|---|---|---|---|---|---|---|
00110002 | 00130003 | 00080002 | 00130001 | 0.028.1 | 0.031.1 | 1 |
00110003 | 00130002 | 00080003 | 00130001 | 0.028.1 | 10.27.2 | 1 |
The component IDs must exist in the components.dat file. The destination point codes must exist in the dpc.dat file. The linkset must exist in the sigChanDev.dat file.
The services.dat table defines the logical services supported by the telephony controller platform. Every process or process group communicates and identifies a desired service and opens an Internet Protocol Channel (IPC) to that service. The component at the other end of the IPC provides a capability to the requesting process. As an example, the service could be handling measurement or reporting alarms.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
servicesName | Text | 32 | [Primary Key] Service name that identifies the service. |
servicesID | Integer | 1 | Service ID. Table index that needs to be unique within the file. |
ipcKind | Text | 1 | IPC Kind. This text character must be one of the following:
|
accessPerm | Text | 2 | The only supported access permission value is: rw = read-write |
ipcDevice | Text | 255 | Directory path to the IPC device. |
format (Optional) | Text | 1 | Text character must be one of the following: r = raw f = XE-formatted (default for backward compatibility) Note For stream devices, the format field may be followed by a set of tokens. Each token is interpreted as the name of a module to be pushed into the stream. If any module names are specified, then the format field should be present. |
| servicesName | servicesID | ipcKind | accessPerm | ipcDevice | format |
1 | p | rw | ../var/procM_input |
| |
ProcessManagement_hi_pri | 2 | p | rw | ../var/procM_hp_input |
|
ConfigManagement | 3 | p | rw | ../var/cfgM_input |
|
The first example identifies the process management function and the service identification. The IPC is a pipe and the access permission granted is read-write. The directory path to the IPC device is ../var/procM_input. This path is relative to the base installation directory.
Corresponding records must exist in components.dat.
The sigChanDev.dat table relates a signaling channel to a signal path to the supporting channel controller to the lineif (in physlineif.dat) and its timeslot.
The Signaling Link Code (SLC) and Priority are used for C7 and SS7 signaling links.
The ASN connection is included here. Currently, it rides over the native Ethernet connection, so the line/timeslot can be anything because they are not used. The channel controller must be the ASP.
| Field Name | Description |
|---|---|
Sigchan CompId | Component ID of the signal channel |
SLC | Signaling Link Code of the C7 signal channel (link) within a signal path (linkset). This value has a range of 0-16 and must be unique within the linkset. |
Prio | Service priority of a C7 link within a linkset. This defines how much message traffic to put on the link relative to the others. This value has a range of 1-16 and can be duplicated between links. All links with the same priority will have messages sent to them based on round-robin scheduling. |
sigPath CompId | Component ID of the signal path towards the Engine. For facility associated signaling, this is the destination ID used in sigPath.dat. For non-facility associated signaling (for example, C7), this is the linkset used for grouping the signaling channels. |
Channel Controller CompId | Component ID of the line used to carry traffic for the signal channel. |
TS (Timeslot) | 64 Kbps timeslot within the line used for the original channel. Depending on line type, there may be 1, 24, or 30 timeslots available for message traffic. |
| Sigchan CompId | Signaling Link Code | Priority | Sigpath CompId | Channel Controller CompId | Line CompId | Timeslot |
|---|---|---|---|---|---|---|
00100001 | 0 | 0 | 00070001 | 00030008 | 00060001 | 1 |
00100003 | 0 | 1 | 00080001 | 0003000C | 00060002 | 0 |
00100004 | 1 | 1 | 00080001 | 0003000C | 00060002 | 1 |
00100005 | 2 | 1 | 00080001 | 0003000C | 00060002 | 2 |
00100006 | 3 | 1 | 00080001 | 0003000C | 00060002 | 3 |
0010000A | 0 | 0 | 000E0001 | 0003000B | 0006000A |
All component IDs must exist in the components.dat table and be valid for the component type. The channel controller component ID must be a channel controller recognized in processes.dat. The line component ID must be a valid line in physLineIf.dat.
The sigChanDevIP.dat table relates a signaling channel that is transported over an IP network to its IP configuration information. It defines the originating UDP port and the terminating IP and UDP Port addresses. One entry is required for each IP connection made.
This file is populated only if you are using ISDN over IP in your sigChanDev.dat configuration. The original sigChanDev.dat file references this file if it contains a 14000x component.
| Field Name | Description |
|---|---|
Sigchan CompId | Component ID of the signal channel. |
Symbolic name for local IP address | Symbolic name for the local IP address. The XECfgParm.dat file provides the mapping between the symbolic name and the IP address. |
Local UDP port | Local UDP port. |
Remote IP address | Remote IP address. |
Remote UDP port | Remote UDP port. |
| Sigchan CompId | Symbolic Name of Local IP Address | Local UDP Port | Remote IP Address | Remote UDP Port |
|---|---|---|---|---|
00100001 | IP_Addr1 | 3001 | 192.12.214.5 | 3001 |
00100002 | IP_Addr1 | 3002 | 192.12.214.4 | 3002 |
The sigPath.dat file defines its associated parameters for each signaling path on the system. These include the symbolic protocol to use for that signaling path; whether that path is connected to the network or user side; whether the path is the A or B side (only for DPNSS), and profile; and the auxiliary signaling path (ASP) participation.
This file uses the signal path component instance as the key. The key must be expanded to the full component ID to differentiate between fully associated signaling (FAS) signal paths and C7 DPCs.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
sigPathID | Hex | 4 | [Primary Key] [Foreign Key] components.dat-componentsID Related fields: bearChan.dat-sigPathID |
protocolFamily | Text | 80 | Protocol family. Restrict to one of the following: ISDNPRI C7 DPNSS CAS SS7 SGCP EISUP ISPNPRI/IP SS7_NTT |
mdoFile | String | 32 | Basename of the MDL object file to load for this sigPath. |
VNETid | String | 4 | Virtual network identification characters, formerly called the closed user group. When defining the VNETid, the values accepted for this field depend on the usage of the D channel. For example, an origination non-customer side D channel of a traffic path should have a value of 0000 or the ASC1 functionality will not work. |
VNETtbl | Integer | 4 | Four-digit table index used to define the VNET characteristics: First 2 digits = on-net supports features between customers On-net the same VNET. On-net is a call with ASP capabilities to a customer with the same VNETid. Second 2 digits =Off-net supports features between customers on different VNETs or non-VNET calls. Off-net is an ASP call with a different VNETid from a non-ASP call. |
swType | Integer | 1 | Integer representing switch type. Use to differentiate between minor differences in switch implementations of a particular protocol. Valid values are based on the corresponding MDL object file in the record. However, a value of zero (0) in this field means there is no switch-specific logic knowledge for the signaling path. Current valid values are:
|
side | Text | 7 | Q.931 call model side. Valid values are: user = User side network = Network side Note This field is ignored for DPNSS. |
A/Bflag | Text | 1 | Identifies the DPNSS call model side as either a or b. Valid values: a = A side b = B side n = Not applicable Note Field is ignored for ETSI. If this field does not string match one of the values, it fails. |
o/e | Integer | 1 | Overlap/enblock digit collection indicator. Valid values are: 0 = Enblock signaling 1 = Channel sends overlap signaling 2 = Channel expects overlap signaling 3 = Channel sends and receives overlap signaling |
ovl_min | Integer | 2 | Minimum number of digits to collect. Default is zero. |
ovl_max | Integer | 2 | Maximum number of digits to collect. Default is 28. |
cr_len | Integer | 1 | Preferred call reference length. Valid values are: 0 = DPNSS (not applicable) 1 = 1 byte call reference (NT switch) 2 = 2 byte call reference (standard ETSI-default) |
prof_id | Text | 4 | Use to identify the sigPath properties record. This field has a fixed length of four characters: The first 2 characters signify on-net. The second 2 characters signify off-net. |
ASP_part | Text | 1 | Used to select whether the auxiliary signal path is to be used or not. The text character must be one of the following: Y = Use ASP N = Do not use ASP |
| 1ASC = Auxiliary Signaling Channel |
| sigPathID | Protocol Family | mdoFile | VNETid | VNETtb1 | side | prof_id | ASP_ part | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
00130002 | SS7-ANSI | ANSISS7 | 0000 | 0101 | 0 | network | a | 0 | 0 | 24 | 2 | 0000 | Y |
00140001 | ISDNPRI | BELL_1268_C3 | 0000 | 0101 | 22 | network | a | 0 | 0 | 24 | 2 | 0000 | N |
00140002 | ISDNPRI | BELL_1268_C3 | 0000 | 0101 | 22 | network | a | 0 | 0 | 24 | 2 | 0000 | N |
In the first line of the example, the protocol family is SS7-ANSI and the MDL object file is identified as ANSISS7. The VNETid is 0000 and the VNETtb1 value is 0101. The next field indicates there is no switch-specific logic. The network side is selected and it is defined as the DPNSS "a" side. Enblock signaling is used, the minimum number of digits to collect is set to the zero default, and the maximum number is set to 24. The call reference length is two bytes---the standard ETSI default. The profile ID, 0101, determines the sigPath properties and characteristics. Finally, the ASP is enabled.
Records may not be deleted from this table if the signaling path is referenced in bearChan.dat. Corresponding records must exist in components.dat.
The following logic applies to both the ovl_min and ovl_max fields:
1. When both of the ovl_min and ovl_max fields = zero (0), the values specified in the XECfgParm.dat file are used.
2. When ovl_min > default for ovl_max, the ovl_min default is used.
3. When ovl_min > ovl_max, then the ovl_max default is used.
4. When ovl_max > default, the default is used.
The snmpmgr.dat file identifies the SNMP managers and consoles. It also contains the host names and IP addresses.
| Field Name | Description |
|---|---|
snmpNotifyEntry | Identifies the SNMP managers. |
snmpTargetAddrEntry | Identifies the IP address of the SNMP managers and consoles. More than one SNMP manager and console can be identified. |
snmpTargetParamsEntry | Identifies the parameters for the SNMP managers. |
#Entry type: snmpNotifyEntry snmpNotifyEntry 1 Console trap nonVolatile snmpNotifyEntry 2 Manager001 trap nonVolatile #Entry type: snmpTargetAddrEntry snmpTargetAddrEntry 1 snmpUDPDomain 127.0.0.1:0 100 3 Console v1ExampleParams nonVolatile 255.255.255.255:0 snmpTargetAddrEntry 2 snmpUDPDomain 127.0.0.1:0 100 3 Console v2cExampleParams nonVolatile 255.255.255.255:0 snmpTargetAddrEntry 3 snmpUDPDomain 192.168.1.2:0 100 3 Manager001 v1ExampleParams nonVolatile 255.255.255.255:0 snmpTargetAddrEntry 4 snmpUDPDomain 192.168.1.2:0 100 3 Manager001 v2cExampleParams nonVolatile 255.255.255.255:0 #Entry type: snmpTargetParamsEntry snmpTargetParamsEntry v1ExampleParams 1 snmpv1 public noAuthNoPriv nonVolatile snmpTargetParamsEntry v2cExampleParams 2 snmpv2c public noAuthNoPriv nonVolatile
The tables.dat file contains numeric identification and UNIX path names for all configuration tables.
This example shows three of the many configuration tables identified in tables.dat. The tablePath field is a path relative to the base installation directory.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
tableName | Text | 32 | [Primary Key] Table name excluding the .dat extension. |
tableNumber | Integer | 8 | Table index which must be unique within this file. |
tablePath | Text | 255 | The UNIX path name for this table. |
| | |
| | |
| | |
Entries must exist for all configuration files defined in this document.
The thresholds.dat file defines all floor and ceiling thresholds used in the system. Each threshold has a type associated with it and information on the alarm category to use when that threshold is crossed.
| Field Name | Data Type | Maximum Length | Specific Instructions and Exceptions |
|---|---|---|---|
sequenceNum | Integer | 4 | Table index which must be unique. |
thresholdName | Text | 32 | [Primary Key] Threshold name. Related file and field: buckets.dat-thresholdName |
thresholdType | Text | 1 | Specifies the type of threshold. Valid values are: F = floor C = ceiling |
thresholdValue | Integer | 8 | Specifies the number of occurrences required to trigger the threshold crossing. If this is zero, the threshold is disabled; otherwise, it is enabled. |
almCategory | String | 80 | [Foreign key] Alarm category used when a threshold is crossed. See the "alarmCats.datAlarm Categories" section . If this is a null string (" "), then no alarm is generated. |
These examples define thresholds identified in buckets.dat by the threshold name. The first record shows that if T_lifses24 crosses over 200, the alarm with the name of LIF SES 24 is generated. This example and the measProf.dat and bucket.dat files shows that this measures Line Interface (LIF) Severely Errored Seconds (SES) over a 24-hour period.
T_lifeses24 | C | 200 | "LIF SES 24" | |
|---|---|---|---|---|
004 | T_chR_btot15 | C | 100 | "CHAN BAD TOT 15" |
016 | T_dlRR_estb15 | C | 10 | "CHAN LINK ESTAB 15" |
Records must not be deleted from table associated with threshold names currently defined in buckets.dat. The almCategory values used in this table must exist in the alarmCats.dat.
Identifies the version number assigned during the software-build process.
"P4.0"
The XECfgParm.dat table is a critical part of the telephony controller because it sets up the operation of the entire environment. Every telephony controller program uses the XECfgParm.dat file. In addition, the XECfgParm.dat table defines run-time parameter values that all processes running under the execution environment can access. Change this .dat file during the installation process or whenever system-wide parameters need to be changed.
For additional information on modifying the XECfgParm.dat file, see the "Setting Up the Execution Environment Configuration Parameters" section in "Preparing Your Telephony Controller."
This table does not contain any relationship-style links to other tables. All parameters currently supported in this table are specified and defined below. Configuration parameters are defined using the following syntax:
facilityName.configparameterName=parameterValue
The facilityName identifies a specific processing subsystem of the telephony controller software.
| Subsystem | Description |
procM | Process manager subsystem |
engine | Engine subsystem |
cfgM | Configuration manager subsystem |
measM | Measurement manager subsystem |
almM | Alarm manager subsystem |
ioChanMgr | Cisco IOS channel manager |
ioChanCtl | Cisco IOS channel controllers |
MML | Man-Machine Language subsystem |
dmpr | The data dumper subsystem |
XE | Execution environment |
foverd | Failover daemon (for optional configuration only) |
* | Default facility |
If no match is found for a facilityName parameter, then a default facility is used. For example, the following are lines used in an XECfgParm.dat file. Table A-37 indicates that all facilities have logging priority set to the Notice level except for the engine. It has the logging priority set to Debug.
| Default Facility | Logging Priorities |
*.logPrio | Notice |
engine.logPrio | Debug |
| Configuration Parameters | Definitions |
|---|---|
*.emshost | The Network Element Management Server (NEMS) that contains the configuration tool. |
*.platformId | Unique platform ID number (numeric) that is used to allow multiple copies of the platform to run on the same host machine. Users can override this value by setting their environment variables. |
*.transpathId | Unique telephony controller identification number that consists of 1-4 hexadecimal digits. |
*.tempDir | ../tmp is the temporary directory. |
*.dataDir | ../var is the volatile data directory. |
*.homeDirRoot | Root directory path for the platform. Relative path names are derived from this root directory. The default is /opt/TransPath. |
*.logFileFmt | .../var/platform_%s.log The name of the log file used when the logDest parameter is set to file. If this file does not exist in XECfgParm.dat, then the default log file is default.log in the log directory. To set this, enter the command .../var/platform_%s.log. |
*.logPrio | Minimum priority of operational messages saved in the logs. This can be changed with the Change Log Level MML command. Valid values in logging priority are:
|
*.logFacility | Default message logging facility that should always have the following value: Platform = General message logging. |
*.logDest | Specialized logging destination to which the operational messages are routed. The default value is syslog. Other valid destinations are:
|
*.eventTrace | - |
*.debugLevel | - |
*.tablesFile | Name of the file describing all of the tables of persistent objects that can be loaded. Set with .../etc/tables.dat. |
*.autonomous | A system-wide flag indicating whether a process is running under the process manager. This parameter determines whether a process is waiting for the process manager to tell it to start running. True means it does not need the process manager, while False means it does. When a process is started by process manager, this value must be False. This does not apply to the process manager itself. For example: For #cfgM.autonomous, the default value is true. For Talk2.autonomous, the default value is false. For MML.autonomous, the default value is true. Note This must be set or MML sessions will quit.For engine.autonomous the default value is true for proper operation. Default values used during installation should not be changed. Changes may prevent the process manager from controlling processes. The autonomous parameter may be overridden for an individual process by entering the following line in XECfgParm.dat: ProcessFacility.autonomous = true The following are valid ProcessFacility values:
|
*.runAsDaemon | Can be true or false. If true, the process runs as a daemon. Its actions include:
If false, the process does not run as a daemon The default value used during installation should not be changed. Changes may prevent the process manager from controlling a process. |
*.IP_Addr1 | Symbolic link for local IP port. For Release 4.0 and higher. |
*.IP_Addr2 | Symbolic link for local IP port. For Release 4.0 and higher. |
*.IP_Addr3 | Symbolic link for local IP port. For Release 4.0 and higher. |
*.IP_Addr4 | Symbolic link for local IP port. For Release 4.0 and higher. |
ioChanCtl.logPrio | Controls logging severity level. Equivalent functionality to *.logPrio but applicable to the I/O channel controller only. Valid values in logging priority are:
|
ioChanMgr.logPrio | Controls logging severity level. Equivalent functionality to *.logPrio but applicable to the I/O channel manager only. Valid values in logging priority are:
|
procM.logPrio | Controls logging severity level. Equivalent functionality to *.logPrio but applicable to the process manager only. Valid values in logging priority are:
|
engine.logPrio | Controls logging severity level. Equivalent functionality to *.logPrio but applicable to the engine only. Valid values in logging priority are:
|
mml.logPrio | Controls logging severity level. Equivalent functionality to *.logPrio but applicable to MML only. Valid values in logging priority are:
|
ioChanCtl.logDest | Equivalent functionality to *.logDest but applicable to the I/O channel controller only. The default value is syslog. Other valid destinations are:
|
ioChanMgr.logDest | Equivalent functionality to *.logDest but applicable to the I/O channel manager only. The default value is syslog. Other valid destinations are:
|
procM.logDest | Equivalent functionality to *.logDest but applicable to the process manager only. The default value is syslog. Other valid destinations are:
|
engine.logDest | Equivalent functionality to *.logDest but applicable to the engine only. The default value is syslog. Other valid destinations are:
|
mml.logDest | Equivalent functionality to *.logDest but applicable to MML only. The default value is syslog. Other valid destinations are:
|
procM.minCheckHealthInterval | Minimum interval in seconds that the process manager uses for checking process health. The default value provided during installation is 10 seconds and should not be changed. |
procM.minCheck | Minimum interval in seconds that the process manager allows for timing out on response when health is checked. The default value provided during installation is 2 seconds and should not be changed. |
procM.minKillGrace | Minimum interval in seconds that the process manager allows between sending a SIGTERM and sending a SIGKILL when forcing a process to exit. The default value provided during installation is 5 seconds and should not be changed. |
procM.almDwell | Interval in seconds the process manager waits before clearing a process alarm. This is used to avoid "bouncing" of alarms. The default value provided during installation is 15 seconds and should not be changed. |
procM.procHealthDfltAlmCat | Default alarm category for the process manager. It is set at pmDefault at installation and should not be changed. |
procM.servicesDir | The ..var/ directory stores the process manager temporary First In First Out (FIFO) information. |
procM.servFmt | Format string used to generate process-specific FIFOs for process management. It has placeholders for platform identification number and process identification number. The default value provided during installation is PM_%d_%d_input and should not be changed. |
procM.recovDbFile | Determines dbm files used for process manager recovery. The default value provided during installation ../var/procMRecovery should not be changed. |
procM.runAsDaemon | Valid values are:
If true, the process manager runs as a daemon and does the following:
If false, it will not run as a daemon. Note The default value used during installation should not be changed. Changes may prevent the process manager from controlling a process. |
cfgM.recovDbFile | Determines dbm files used for cfgM recovery. The default value provided during installation ../var/cfgMRecovery should not need to be changed. |
engine.SysVirtualSwitch | For Release 4.0 and higher. Provides a default value that indicates whether the software is a signaling controller or virtual switch controller. Valid values are:
The default is set to false. |
engine.SysCdrCollection | Provides a default value that allows CDR generation. Valid values are:
|
engine.SysPropagate | Provides for the auto-blocking of C7 CICs and ISDN sigPaths when set to true. If true, if all the CICs mated to a single ISDN-PRI signal path are blocked, the engine instructs the channel manager to take the signal path out-of-service. When one of the CICs is unblocked, the engine instructs the channel manager to set the signal path in-service. The default setting is false. Valid values are true or false. |
engine.SysCLIval | Provides a default value that indicates whether Calling Line Identity (CLI) Validation processing is to be performed on phone calls. The default value is false. The following are valid values:
|
engine.SysToneDetect | Provides a default value that indicates whether tone detection (for in-band analog signals) is to be performed. Valid values are:
|
engine.SysNumTrans | Provides a default value which indicates whether number translation is to be performed on phone calls. Valid values are:
|
engine.SysMinOverlap | Positive integer indicating the minimum number of dialed digits allowed on a signaling channel that can carry overlap signaling call initiation messages. The default setting is 0. |
engine.SysMax | Positive integer indicating the maximum number of dialed digits allowed on a signaling channel that can carry overlap signaling call initiation messages. |
engine.LCMMdlFile | Universal call model MDL object file. Set with .../lib/lcm.mdo. |
engine.CCMdlFile | Call Context MDL object file. Set with .../lib/cc.mdo. |
engine.mdoDir | Directory where the .mdo files reside. |
Ovl1OnsetThresh | Overload parameter that controls engine FIFO queue levels prior to onset of overload control, or call rejection. A percentage of the total queue capacity at which the overload level will be in effect. |
Ovl1AbateThresh | Overload parameter that controls engine FIFO queue levels prior to onset of overload control, or call rejection. A percentage of total queue capacity at which the overload level will no longer be in effect. This value must be greater than Ovl1OnsetThresh. |
Ovl1RejectPercent | Overload parameter that controls engine FIFO queue levels prior to onset of overload control, or call rejection. A percentage of new calls that will be rejected at this overload level. For example, 20% means 1 out of 5 new calls will be rejected at this level. |
Ovl2OnsetThresh | Overload parameter that controls engine FIFO queue levels prior to onset of overload control, or call rejection. A percentage of the total queue capacity at which the overload level will be in effect. |
Ovl2AbateThresh | Overload parameter that controls engine FIFO queue levels prior to onset of overload control, or call rejection. A percentage of total queue capacity at which the overload level will no longer be in effect. This value must be greater than Ovl2OnsetThresh. |
Ovl2RejectPercent | Overload parameter that controls engine FIFO queue levels prior to onset of overload control, or call rejection. A percentage of new calls that will be rejected at this overload level. For example, 20% means 1 out of 5 new calls will be rejected at this level. |
Ovl3OnsetThresh | Overload parameter that controls engine FIFO queue levels prior to onset of overload control, or call rejection. A percentage of the total queue capacity at which the overload level will be in effect. |
Ovl3AbateThresh | Overload parameter that controls engine FIFO queue levels prior to onset of overload control, or call rejection. A percentage of total queue capacity at which the overload level will no longer be in effect. This value must be greater than Ovl3OnsetThresh. |
Ovl3RejectPercent | Overload parameter that controls engine FIFO queue levels prior to onset of overload control, or call rejection. A percentage of new calls that will be rejected at this overload level. For example, 20% means 1 out of 5 new calls will be rejected at this level. |
ioChanMgr.trace | Creates unit test tracing of line and channel state machines. Generates a considerable amount of information to the log. Set to true only when debugging a particular problem with line or channel service state problems. |
ioChanMgr.alarmTimer | Polling period to check for alarms in the I/O Subsystem. Should be set to zero (the default). This prevents the hardware alarms from being polled. |
ioChanMgr.statTimer | Polling period, measured in milliseconds, used to collect measurements in the I/O Subsystem. This should be set at approximately 30 seconds (30000 milliseconds). Setting to 0 (the default) prevents statistics from being polled. This is not necessary for some I/O cards. |
ioChanCtl.DPNSSTestFrames | The default is set to true. |
MeasM.evalInterval | Measurement manager polling interval in seconds. The default setting is 60 seconds. |
measM.proxyFile | Measurement manager shared data table. This parameter is set using ../var/measProxy. |
measM.proxyFile | Expected maximum number of entries in the proxy file. This value is based on the number of components multiplied by the number of measurements per component. The default value is 2500. |
almM.runAsDaemon | If true, the alarm manager runs as a daemon and does the following:
If false, it will not run as a daemon Note The default value is normally set to false during installation and should not be changed. Changes may prevent the alarm manager from controlling a process. |
MML.autonomous | The default value is true. It must be set or MML sessions do not operate properly. |
MML.runAsDaemon | The default setting is false. If set to true, MML runs as a daemon and does the following:
If false, it will not run as a daemon. The default value used during installation should not be changed. Changes may prevent MML from controlling a process. |
MML.logDest | This configuration parameter displays where the MML log file resides. This parameter should be set to either syslog or file. Do not use all because it will scramble the screen unless stderr is redirected. Note Running in debug mode causes the Syslog.Platform files to become very large. These files are frequently deleted by an automatic system process. Cisco does not recommend logging to another destination (such as Platform_1.log) while running in debug mode, because the telephony controller will not automatically delete these files. The hard disk will become full and cause system crashes. |
MML.timeout | Default timeout period for commands in milliseconds. If the command takes longer than this to execute, the MML session aborts with an error. The default is 4000 milliseconds. |
MML.command | Specific command timeout where command is the command name and the value to which it is set is in milliseconds. For example, the following entries in XECfgParm.dat might be: MML.timeout = 4000 MML.set-sc-state = 8500 The default values provided during installation are normally optimal. MML is configured to stop all commands after 4 seconds except for SET-SC-STATE which stops after 10 seconds. |
MML.chg-cfg | Change configuration timeout. Default value is 10000 milliseconds. |
MML.startPM | This parameter starts the telephony controller; the command line is /etc/init.d/transpath start |
MML.stopPM | This parameter stops the telephony controller; the command line is /etc/init.d/transpath stop |
XE.heartBeatRate | Heartbeat rate in seconds. Range is 5 to 255. Must correspond to the physical setting on the alarm relay unit (ARU). If not set, 255 will be used. The default is 60 seconds. |
XE.ARUWriteDevice | Name of the device from which the ARU is expecting to read the alarm strings. If not set, # /dev/tty will be used. Set this to /dev/null if an ARU is not attached to a network element. |
foverd.conn1Type | Sets the desired connection type for connection number 1. Valid values are serial or socket. |
foverd.conn1AddrA | Address of target system number 1. Valid values are:
|
foverd.conn1AddrB | Not used if the connection is serial. Otherwise, specifies the remote IP address and port number of target system number 1. |
foverd.conn2Type | Sets the desired connection type for connection number 2. Valid values are serial or socket. |
foverd.conn2AddrA | Address of target system number 2. Valid values are:
|
foverd.conn2AddrB | Not used if the connection is serial. Otherwise, specifies the remote IP address and port number of target system number 2. |
foverd.heartbeatInterval | Interval in milliseconds that defines the frequency at which the failover daemon exchanges heartbeat messages with its peer. Default value is 4000. |
foverd.ackTimeout | The timeout period in milliseconds for heartbeat messages received from the failover daemon. For each message the failover daemon sends, the peer sends an ACK or NOACK message. The timeout value is used to track the number of ACK or NOACK messages received within the timeout period. Default value is 1000. |
foverd.graceShutTimeout | Interval in milliseconds the failover daemon waits before shutting down the process manager, which shuts down the processes it controls. Default value is 6000. |
foverd.forceShutTimeout | Interval in milliseconds the failover daemon waits before forcefully shutting down the platform. Default value is 1000. |
foverd.abswitchTestInterval | Interval in milliseconds that determines how often to test if the A/B switch is present. Default value is 30000. |
foverd.commRetryInterval | Interval in milliseconds that governs the frequency for retrying to open a connection. Connection types include:
Default value is 30000. |
foverd.statusRptInterval | Interval in milliseconds that governs the frequency at which the failover daemon logs statistics on the different connections and failures it encountered exchanging messages with its peer. Logs are created in the syslog directory. Default value is 360000. |
foverd.peerCommTimeout | Timeout period in milliseconds after which the remote system is assumed to be unavailable. Failover is triggered automatically if there is no communication with the remote system after this timeout period. Default value is 10000. Note A timeout value that is too small causes false failovers, resulting in possible service interruptions. |
foverd.delayTimeout | The amount of delay offset added when the two failover daemons become too closely synchronized. Controls how long the failover daemon waits at startup before sending messages to its peer. Default value is 1000 milliseconds. |
foverd.transitionTimeout | Timeout period for transition between different states of the failover daemon. Determines how long the system waits for a graceful transition to a new state before forcing the transition. If timeout occurs, the system is restarted. |
foverd.fifo1 | Name of FIFO file used by failover daemon for testing purposes. |
foverd.fifo2 | Name of FIFO file used by failover daemon for testing purposes. |
foverd.udpPortA | The socket port number used by the failover daemon running on the local system. Should be greater than 1024, and should not conflict with socket ports used by any other applications on the same host. |
foverd.udpPortB | The socket port number used by the failover daemon running on the remote system. Should be greater than 1024, and should not conflict with socket ports used by any other applications on the same host. |
foverd.udpPort | The socket IP address used by the failover daemon running on the local system to exchange messages with the remote system. |
foverd.udpPort | The socket IP address used by the failover daemon running on the remote system to exchange messages with the local system. |
foverd.asyncPort | The name of the serial port used to exchange messages with the remote system. Normally set to /dev/cua/a000. |
foverd.pollTimeout | The frequency at which new I/O messages are processed, in milliseconds. The default value is set to 4000. |
foverd.peerComm | The timeout period (in milliseconds) after which the remote system is assumed to be unavailable. Failover is triggered automatically if there is no communication with the remote system after this timeout period. The default value is normally set to 10000, which is optimal. A timeout value that is too small will cause false failovers to occur, resulting in possible service interruptions. |
foverd.delayTimeout | Not used in Release 4.0 and higher. The amount of delay offset added when the two failover daemons become too closely synchronized. The default value is set to 1000. |
foverd.pidFile | The file used to store process information used for recovery purposes. The default value is /tmp/foverdpids. |
foverd.abswitchPort | The UNIX device name of the serial connection to the A/B switch used by the local failover daemon to trigger switchover of communication lines when it becomes the master system. The default setting is /dev/cua/a001. |
foverd.procMCmdLine | The command line used by the failover daemon to start the process manager. This value will only need to be changed if the software distribution is installed in a non-standard location. The default setting is /opt/TransPath/bin/procM. |
foverd.frepldCmdLine | The command line used by the failover daemon to start the file replication daemon. This value will only need to be changed if the software distribution is installed in a nonstandard location. The default setting is /opt/TransPath/bin/frepld. |
foverd.runAsDaemon | Valid values are:
The default setting is true. If set to true, foverd runs as a daemon and does the following:
If false, foverd will not run as a daemon. Note The default value used during installation should not be changed. Changes may prevent foverd from controlling a process. |
foverd.logPrio | Minimum priority of operational messages saved in the logs for foverd. Can be changed via the Change Log Level MML command. The default value is debug. debug---This priority is used only for detailed debugging messages. Logging at this priority is not recommended during production, because this causes a large volume of messages to be logged, and degrades system performance. |
foverd.logDest | Specialized logging destination to which the foverd operational messages are routed. Valid values are:
The default value is all. Note Running in debug mode causes the Syslog.Platform files to become very large. These files are frequently deleted by an automatic system process. Cisco does not recommend logging to another destination (such as Platform_1.log) while running in debug mode, because the telephony controller will not automatically delete these files. The hard disk will become full and cause system crashes. |
product.vendor | The vendor of the telephony controller software, Cisco Systems, Inc. |
product.version | The version level of the telephony controller software. |
product.time | Time when the telephony controller software was transferred to CD-ROM. |
Posted: Tue Mar 28 08:35:25 PST 2000
Copyright 1989 - 2000©Cisco Systems Inc.