Command Line Interface Reference Guide - Revised June 30, 2009
Chapter 7: Tandem Provisioning

Table Of Contents

Tandem Provisioning

Automatic Number Identification

Automatic Number Identification Screening (Release 4.2)

Automatic Number Identification Screening Profile (Release 4.2)

Cause Code Map

Cause Code Map Profile

H.323 Gateway

H.323 Gateway to Gatekeeper

H.323 Terminal (Release 4.2)

H.323 Terminal Profile (Release 4.2)

H.323 Trunk Group Profile

II White Black List

Service Provider

Technical Prefix Group

Technical Prefix Group Profile

Trunk Group Feature Data

Trunk Group Service Profile


Tandem Provisioning


Revised: July 24, 2009, OL-3743-42

This chapter describes the Call Agent Tandem Provisioning commands and their associated tables.


Note In this chapter, an asterisk preceding a token name means the token is mandatory. A token without an asterisk is optional.


Automatic Number Identification

The Automatic Number Identification (ANI) table is used for the ANI screening feature. The table keeps track of allowed/blocked status ANI. If the ANI status is blocked, the call is not allowed.

Table Name: ANI

Table Containment Area: FSPTC

Command Types

Show, add, change, and delete

Examples

show ani id=972-671-2355;
add ani id=972-671-2355;
change ani id=972-671-2355; active=N;
delete ani id=972-671-2355;

Usage Guidelines

Primary Key Token(s): id

Foreign Key Token(s): cos-restrict-id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Other: Impacts Split-NPA.

Syntax Description

* ID

Primary key. ANI of the calling party.

VARCHAR(14): 1-14 numeric characters in the format NDC-EC-DN.

ACTIVE

Indicates status of ANI.

CHAR(1): Y/N (Default = Y).

Y—Active

N—Blocked

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

COS-RESTRICT-ID

Foreign key: COS Restrict table. Use the cos-restrict-id assigned to the ANI if present, else use the cos-restrict-id assigned to the ANI profile.

VARCHAR(16): 1-16 ASCII characters.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).


Automatic Number Identification Screening (Release 4.2)

The Automatic Number Identification (ANI) Screening (ani-screening) table performs ANI screening on calls received over a trunk group. Normally, ANI screening is performed on calls received from a PBX (ISDN, H.323, and SIP). This table allows performing ANI-based routing in addition to ANI screening. When a record is found that matches the incoming ANI, the subscriber ID associated with the record is used for further digit analysis and routing.

Table Name: ANI-SCREENING

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show ani-screening id=xyz;
add ani-screening id=xyz; row-id=1; from-dn=972-222-1100; to-dn=972-222-1199; 
main-sub-id=sub1;
change ani-screening id=xyz; row-id=1; to-dn=972-222-1299;
delete ani-screening id=xyz; row-id=1;

Usage Guidelines

Primary Key Token(s): id, row-id

Foreign Key Token(s): id

Add Rules:

String lengths must match.

From-dn must be less than or equal to the to-dn.

No overlapping DN range is allowed across the table for the same ani-screening-profile-id.

Change Rules: Same as add rules. Row-id is required.

Delete Rules: Row-id is required.

Syntax Description

* ID

Primary key. Foreign key: ANI Screening Profile table. The ANI screening id. Must match the id in the ANI Screening Profile table.

VARCHAR(16): 1-16 ASCII characters.

* ROW-ID

Primary key. Used to create multiple records against the same ani-screening-profile-id. When multiple records are assigned, the search is started with the lowest row-id value.

INTEGER: 1-65535, automatically generated if not provisioned. Next ROW-ID value = MAX+1.

* FROM-DN

Lower range of DN.

VARCHAR(14): 1-14 ASCII characters.

* TO-DN

Upper range of DN.

VARCHAR(14): 1-14 ASCII characters.

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

MAIN-SUB-ID

Main subscriber id for a PBX. The ANI-based routing feature uses this subscriber id for routing purposes instead of using the DN2subscriber table.

VARCHAR(30): 1-30 ASCII characters.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

REGION (Not used)

Specifies the region to use if a policy region is applied to calls using this screening id.

VARCHAR(16): 1-16 ASCII characters.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).


Automatic Number Identification Screening Profile (Release 4.2)

The Automatic Number Identification (ANI) Screening Profile (ani-screening-profile) table defines an id to perform ANI screening. The ID is assigned to a trunk group when ANI screening is required or when ANI-based routing is required for calls originating over a trunk group.

Table Name: ANI-SCREENING-PROFILE

Table Containment Area: EMS, CA

Command Types

Show, add, change, and delete

Examples

show ani-screening-profile; 
add ani-screening-profile id=xyz; description=This profile ID is used to validate 
subscribers belonging to XYZ enterprise; 
change ani-screening-profile id=xyz; description=This profile ID is used to validate ANIs 
belonging to XYZ enterprise clients; 
delete ani-screening-profile id=xyz; 

Usage Guidelines

Primary Key Token(s): id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* ID

Primary key. ANI screening profile id.

VARCHAR(16): 1-16 ASCII characters.

ANI-SCREENING-
ACTION

Specifies the type of ANI screening action.

VARCHAR(16): 1-16 ASCII characters. Permitted values are:

ALLOW (Default)—Use default trunk group routing if no match.

REJECT—Reject Call if no match found in the ANI Screening table.

DESCRIPTION

Described by the service provider.

VARCHAR(64): 1-64 ASCII characters.

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).


Cause Code Map

The Cause Code Map (cause-code-map) table processes cause codes received from an outgoing interface, and also when sending cause codes to a previous switch over an incoming interface. It also specifies why a call was released.

When used for an outgoing interface, this table serves the following purposes:

Determines what action the Cisco BTS 10200 Softswitch takes for cause codes received over an outgoing interface.

Maps received cause codes to normalized cause codes.

When used for an incoming interface, the table maps normalized cause codes to a cause code sent over the incoming interface. If no entry is found in the table, the Cisco BTS 10200 Softswitch uses the cause code as is.

Table Name: CAUSE-CODE-MAP

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show cause-code-map id=ss7cca; recv-cause-code=31;
add cause-code-map id=ss7cca; recv-cause-code=31; std-cause-code=35; action=reattempt;
change cause-code-map id=ss7cca; recv-cause-code=31; action=redirect;
delete cause-code-map id=ss7cca; recv-cause-code=31;

Usage Guidelines

Primary Key Token(s): id, cause-code-type, recv-cause-code

Foreign Key Token(s): id

Add Rules: Foreign key constraints.

Change Rules: Foreign key constraints.

Delete Rules: Foreign key constraints.

Syntax Description

* ID

Primary key. Foreign key: Cause Code Map Profile table. Indicates the cause code received on the outgoing leg.

VARCHAR(16): 1-16 ASCII characters.

* ACTION

Identifies an action to perform when a given cause code is received on the outgoing leg.

VARCHAR(16): 1-16 ASCII characters. Permitted values are:

REATTEMPT—Reattempt the call by re-querying the gatekeeper.

RELEASE (Default)—Release the call with the appropriate cause value.

REDIRECT—Reroute the call by retranslating the redirecting number.

ROUTE-ADVANCE—Route advance the call to the next trunk group in the route if a next trunk group exists.

* CAUSE-CODE-
TYPE

Primary key. Specifies the cause code type. The combination of cause code type and received cause code is used to map to a standard cause code. See the ITU-T Recommendation Q.850 for more information.

VARCHAR(32): 1-32 ASCII characters. Permitted values are:

ANSI-ISUP-BASE—ANSI ISUP Base Cause Codes

ANSI-ISUP-GR317—ANSI ISUP GR317 Cause Codes

GTD—GTD Cause Code

H225—H225 Cause Code

H323-RAS-ARJ—Admission Request Rejected (ARJ) Cause Code

H323-RAS-BRJ—Bandwidth Request Rejected Cause Code

ISDN-4ESS-PRI—ISDN 4ESS PRI Cause Code

ISDN-5ESS-PRI—ISDN 5ESS PRI Cause Code

ISDN-DMS-100—ISDN DMS 100 Cause Code

ISDN-DMS-PRI—ISDN DMS PRI Cause Code

ISDN-ITU-Q931-PRI—ISDN ITU Q931 PRI Cause Code

ISDN-US-NI2-PRI—ISDN NI2 PRI Cause Code

MGCP—MGCP Cause Codes

Q761-ISUP-BASE—Q761 ISUP Base Cause Codes

Q761-ISUP-CHINA—Q761 ISUP China Cause Codes

SIP—SIP Cause Code


Note For cause code mapping on ISDN trunk groups, set the cause-code-type as GTD. Note that other cause-code-type values are unusable for ISDN.


* RECV-CAUSE-
CODE

Primary key. Indicates the received cause code.

NUMERIC(4): 1-4 numeric digits.

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).

STD-CAUSE-CODE

Represents the standard cause code based on the received cause code. As a default, this cause code value is used for call processing.

NUMERIC(4): 1-4 numeric digits (Default = 34).


Cause Code Map Profile

The Cause Code Map Profile (cause-code-map-profile) table defines cause code map IDs, defines default mappings to a standard cause code (Q.850), and defines default actions to take. These IDs must be provisioned before provisioning either the Cause Code table or the Trunk Group table.

Table Name: CAUSE-CODE-MAP-PROFILE

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show cause-code-map-profile id=ss7cc;
add cause-code-map-profile id=ss7cca; description=h323 cause code mapping table;
change cause-code-map-profile id=ss7cca; description=ss7 cause code mapping table used in 
service provider X network;
delete cause-code-map-profile id=ss7cca; 

Usage Guidelines

Primary Key Token(s): id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* ID

Primary key. Defines the IDs used in the Cause Code Map table.

VARCHAR(16): 1-16 ASCII characters.

DESCRIPTION (EMS-only field)

Described by the service provider.

VARCHAR(64): 1-64 ASCII characters.

AUTO-
REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).


H.323 Gateway

The H.323 Gateway (h323-gw) table defines the capabilities of each H.323 protocol gateway. There can be four instances of an H.323 gateway running on the Call Agent at any one time.

Table Name: H323-GW

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show h323-gw id=gw1@cisco.com
add h323-gw id=gw1@cisco.com; gw-h225-port=11;tgn-id=23; password=00ABCFFF; 
security-level=ENDPOINT
change h323-gw id=gw1@cisco.com;gw-h225-port=10
delete h323-gw id=gw1@cisco.com;

Usage Guidelines

Primary Key Token(s): id

Foreign Key Token(s): tgn-id, tech-prefix-group-id

Unique Key Token(s): annexe-udp-port

Add Rules:

low-water-mark must be less than or equal to high-water-mark, which must be less than or equal to max-voip-calls.

status=OOS.

Change Rules: low-water-mark must be less than or equal to high-water-mark, which must be less than or equal to max-voip-calls.

The following tokens can be changed only if status=OOS: password, annexe-supp, annexe-udp-port, annexr-supp.

Delete Rules: Foreign key constraints, status must be OOS.


Note The Internet protocol type of signaling (IPTOS) tokens in the Syntax Description section allow setting various options on the TCP socket to tune, or optimize, certain performance parameters.


Syntax Description

* ID

Primary key. Name of the H.323 gateway.

VARCHAR(16): 1-16 ASCII characters.

* TGN-ID (or * TG)

Foreign key: Trunk Group table. The tgn-id is used to hand off a call from H323 to call processing. A call from an H.323 network is treated as a call from another softswitch. This field can also be provisioned by specifying the trunk group instead of a tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it.

INTEGER: 1-99999999.

* GW-H225-PORT

This port number is used for the H.225 (H.323 is an umbrella protocol and H.225 is used for signaling control) interface. This is the port the Call Agent H.323 gateway is listening on—TCP port. Any number of ports can be specified, but only four are used at any one time.

INTEGER: 0-65535.

ANNEXE-
RETRANSMIT-
ATTEMPTS

Specifies how many times to resend a message to the remote entity before dropping the message.

INTEGER: 1-10 (Default = 8).

ANNEXE-
RETRANSMIT-
MULTIPLIER

The multiplication factor of the previous retransmit interval used for subsequent Annex E packet retransmissions.

INTEGER: 1-10 (Default = 2).

ANNEXE-
RETRANSMIT-
TIMER

Initial value of the retransmit timer. Determines whether to resend Annex E packets if an ack is not received. All subsequent retransmissions are based on an exponential back-off algorithm using the annexe-retransmit-multiplier token.

INTEGER: 1-30000 in milliseconds (Default = 500).

ANNEXE-SUPP

Specifies whether the gateway instance supports Annex E.

CHAR(1): Y/N (Default = Y).

ANNEXE-UDP-PORT

Unique key. Specifies what port will receive incoming Annex E messages.

INTEGER: 0-65535. Should be unique for each h323-gw entry.

ANNEXR-SUPP
(Not used)

Specifies whether Annex R Redundancy procedures are supported.

CHAR(1): Y/N (Default = N)

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

CALL-START-MODE

Note Obsolete in Release 4.2. Moved to the H.323 Trunk Group Profile and H.323 Terminal
Profile tables.

Specifies the call start mode for outgoing H.323 calls.

VARCHAR(10): 1-10 ASCII characters. Permitted values are:

FAST-START (Default)

SLOW-START

CODEC-NEG-
ATTEMPTS (Release 4.2)

Total number of retries to renegotiate the codec in the case of an asymmetric codec condition.

Note Used only when the code-neg-supp field in the H.323 Trunk Group Profile table or H.323 Termination Profile table is set to Y.

INTEGER: 0-10 (Default = 4).

CODEC-NEG-TIMER (Release 4.2)

The amount of time in milliseconds that the H.245 slave waits for the H245 master to reoriginate an OLC. Used when two H.323 endpoints in the call end up with an asymmetric codec condition (different codecs for the forward and reverse logical channels).

Note Used only when the code-neg-supp field in the H.323 Trunk Group Profile table or H.323 Termination Profile table is set to Y.

INTEGER: 1-30,000 (Default = 200).

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

HIGH-WATER-MARK

Tells the H.323 gatekeeper that the maximum capacity of this instance has been reached and to not send any more calls.

INTEGER: 1-65535 (Default = 0).

IPTOS-SIG-
LOWDELAY

Specifies whether to set low delay. Low delay refers to the waiting time, or latency involved in sending and receiving a packet. You can set various options on the TCP socket to tune or optimize for certain performance parameters. The TOS provides an indication of the abstract parameters of the quality of service desired. These parameters guide the selection of the actual service parameters when transmitting a datagram through a particular network. See RFC 1349, RFC 791, and RFC 795 for detailed information.

CHAR(1): Y/N (Default = Y).

Y—(1) Set to low delay.

N—(0) Set to normal delay.


Caution Cisco does not recommend using any value other than the specified default. Changing this value from its default may significantly impact network performance. Contact Cisco TAC for further information.

IPTOS-SIG-
PRECEDENCE

Specifies the signaling precedence.

VARCHAR(16): 1-16 ASCII characters. Permitted values are:

NETCONTROL (=7)

INTERNETCONTROL (=6)

CRITICAL (=5)

FLASHOVERRIDE (=4)

FLASH (DEFAULT=3)

IMMEDIATE (=2)

PRIORITY (=1)

ROUTINE (=0)


Caution Cisco does not recommend using any value other than the specified default. Changing this value from its default may significantly impact network performance. Contact Cisco TAC for further information.

IPTOS-SIG-
RELIABILITY

Specifies whether to set reliability. Reliability refers to the dependability of packet delivery. The TOS provides an indication of the abstract parameters of the quality of service desired. These parameters guide the selection of the actual service parameters when transmitting a datagram through a particular network. See RFC 1349, RFC 791, and RFC 795 for detailed information.

CHAR(1): Y/N (Default = N).

Y—(1) Set to high reliability.

N—(0) Set to normal reliability.


Caution Cisco does not recommend using any value other than the specified default. Changing this value from its default may significantly impact network performance. Contact Cisco TAC for further information.

IPTOS-SIG-
THROUGHPUT

Specifies whether to set throughput. Throughput refers to the actual amount of useful and nonredundant information that is transmitted or processed. The relationship between what went in one end of the network and what came out the other is a measure of the efficiency of that communications network. Throughput is a function of bandwidth, error performance, congestion, and other factors. The TOS provides an indication of the abstract parameters of the quality of service desired. These parameters guide the selection of the actual service parameters when transmitting a datagram through a particular network. See RFC 1349, RFC 791, and RFC 795 for detailed information.

CHAR(1): Y/N (Default = N).

Y—(1) Set to high throughput.

N—(0) Set to normal throughput.


Caution Cisco does not recommend using any value other than the specified default. Changing this value from its default may significantly impact network performance. Contact Cisco TAC for further information.

IRR-BANDWIDTH-
SUPP

Specifies if information received response (IRR) bandwidth support is available.

CHAR(1): Y/N (Default = N).

Y—IRR bandwidth support is available.

N—IRR bandwidth support is not available.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

LOW-WATER-MARK

Tells the H.323 gatekeeper that the lowest capacity of this instance has been reached and to start sending calls again.

INTEGER: 1-65535 (Default = 0).

MAX-VOIP-CALLS

Maximum number of voice over IP calls allowed in this instance of the Call Agent.

INTEGER: 1-65535 (Default = 65535).

H245-TUNNELING

Note Obsolete in Release 4.2. Moved to the H.323 Trunk Group Profile and H.323 Terminal
Profile tables.

Specifies whether H.245 tunneling is allowed. Tunneling allows using the Call Agent signaling channel for both connection and signaling control. Accelerates call setup time.

VARCHAR(8): 1-8 ASCII characters. Permitted values are:

DEFAULT—Default H245 tunneling operation.

DISABLE—Disable H245 tunneling.

OPER-STATUS

Operational status of the gateway.

VARCHAR(5): 1-5 ASCII characters. Permitted values are:

NF (Default)—Nonfaulty.

FA—Faulty.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

PASSWORD

Mandatory only if security=Y. Subscription password. This is configured in the gateway; can be changed without taking the gateway out of service.

VARCHAR(16): 1-16 ASCII characters. The ASCII characters are limited to HEX characters only.

SECURITY

Indicates if H.323 security is enabled on the gateway.

CHAR(1): Y/N (Default = Y).

SECURITY-LEVEL

Mandatory only if security=Y. Security level can be either on a Call Agent H.323 gateway endpoint, on all calls, or both.

VARCHAR(12): 1-12 ASCII characters. Permitted values are:

ENDPOINT—Specifies whether to validate all RAS messages sent by the gateway using the cryptoTokens that are generated based on the security password configured for the gateway.

PER-CALL (Not used)—Specifies whether to validate only the admission messages from the H.323 endpoints to the gateway (admission request [ARQ] messages). The gateway prompts the user for an account number and personal identification number (PIN). These two numbers are sent from the endpoint and are used to authenticate the originator of the call.

ALL—Not used.

SOURCE-BASED-
ROUTING (Release 4.2)

Used to perform source-based routing. The Cisco BTS 10200 Softswitch chooses either the incoming trunk-grp or the h323-term based on this token.

When using any of the source (SRC) terminal-based routing methods, the AliasAddress field in the message is matched against the tsap-addr field of trunk-grp (if the incoming call is from an H.323 virtual trunk group) or the alias-addr field in the H.323 Terminal table (if the incoming call is from an H.323 terminal such as a phone).

VARCHAR(25): 1-25 ASCII characters. Permitted values are:

NONE (Default)—Do not use any source-based routing method. The default trunk-grp configured in the tgn-id field of the H.323 Gateway table is used as the incoming trunk group.

SRC-TERMINAL-AUTO—Use source-based routing based on the availability of following parameters in the following preferential order:

1. SRC-TRANSPORT-ID

2. SRC-URL-ID

3. SRC-EMAIL-ID

4. SRC-H323-ID

5. NONE

SRC-TSAP-ADDR—Use the source TSAP address of the incoming setup message for determining incoming the H.323 virtual trunk group.

SRC-TERMINAL-H323-ID—Use the H323-ID sourceAddress (AliasAddress) field from the incoming setup message to determine the incoming the H.323 virtual trunk group. If not available, do not use source-based routing.

SRC-TERMINAL-URL-ID—Use the url-ID sourceAddress (AliasAddress) field from the incoming setup message for determining the incoming H.323 virtual trunk group. If not available, do not use source based-routing.

SRC-TERMINAL-EMAIL-ID—Use the email-ID sourceAddress (AliasAddress) field from the incoming setup message for determining the incoming H.323 virtual trunk group. If not available, do not use source-based routing.

SRC-TERMINAL-TRANSPORT-ID—Use the transport-ID sourceAddress (AliasAddress) field from the incoming setup message for determining the incoming H.323 virtual trunk group. If not available, do not use source-based routing.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).

STATUS

Service state.

VARCHAR(15): 1-15 ASCII characters. Permitted values are:

OOS (Default)—Out-of-Service.

INS—In-Service.

STATUS-ENQ-TIMER (Release 4.2)

The amount of time in seconds that a Cisco BTS 10200 Softswitch H.323 endpoint waits for a status message after sending a status enquiry message.

INTEGER: 1-30 (Default = 4).

INTEGER: 0-30 (Default = 4) (Release 4.4.1).

TCP-MAX-AGE

Maximum age of a call in seconds.

INTEGER: 1-1800 (Default = 30).

TCP-MAX-LIMIT

Maximum number of allowed calls per TCP in this instance of the Call Agent. It is used for channel multiplexing.

NUMERIC: 1-15 (Default = 5).

TECH-PREFIX-GRP-
ID

Foreign key: Technical Prefix Group Profile table. Specifies the Tech Prefix Group to register with the gatekeeper. It is used to determine routing and must match a specific ID in the Technical Prefix Group table.

VARCHAR(16): 1-16 ASCII characters.

TIME-TO-LIVE (Release 4.4.1)

Time to live, in seconds.

INTEGER: 0-600 (Default = 60). 0 = infinite.


H.323 Gateway to Gatekeeper

The H.323 Gateway to Gatekeeper (h323-gw2gk) table describes gatekeeper characteristics for each gateway in an H.323 network. Multiple gateways can have the same gatekeeper, or there can be a different gatekeeper for each gateway. However, a gateway can be registered to one gatekeeper at a time. A gatekeeper identifies, controls, counts, and supervises gateway traffic, including, but not limited to, gateway registration, address resolution, bandwidth control, and admission control.

Table Name: H323-GW2GK

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show h323-gw2gk h323-gw-id=gw1; gk-id=gk1;
add h323-gw2gk h323-gw-id=gw1; gk-id=gk1; gk-ip-addr=190.170.101.123
change h323-gw2gk h323-gw-id=gw1; gk-id=gk1; priority=1;
delete h323-gw2gk h323-gw-id=gw1; gk-id=gk1;

Usage Guidelines

Primary Key Token(s): h323-gw-id, gk-id

Foreign Key Token(s): h323-gw-id

Add Rules:

gk-ip-addr is required if multicast=n

gk-ras-port is required if multicast=n

gk-ip-addr must be entered as an IP address (Release 4.4.1)

Change Rules: gk-ip-addr is required if multicast=n; gk-ras-port is required if multicast=n.

Delete Rules: Foreign key constraints.

Syntax Description

* H323-GW-ID

Primary key. Foreign key: H.323 Gateway table. The name of the Call Agent H.323 gateway. This token must match an ID in the H.323 Gateway table.

VARCHAR(16): 1-16 ASCII characters.

* GK-ID

Primary key. Indicates the H.323 identification of the gatekeeper. The recommended format is domain name. This ID can be obtained using a discovery confirm (DCF), or a registration confirm (RCF) inquiry.

VARCHAR(16): 1-16 ASCII characters.

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DESCRIPTION (EMS-only field)

Described by the service provider.

VARCHAR(64): 1-64 ASCII characters.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

GK-IP-ADDR

Mandatory if multicast=n. Defines the IP address that identifies the gatekeeper. This ID can be obtained using a discovery confirm (DCF), or a registration confirm (RCF) inquiry.

VARCHAR(32): 1-32 ASCII characters. Value must be entered as an IP address as of Release 4.4.1. For example: 64.101.150.144

GK-RAS-PORT

Mandatory if multicast=n. Defines the gatekeeper (GK) request admission status (RAS) port number to use.

INTEGER: 1-65535.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

MULTICAST

Indicates that the gateway will use the multicast address in the gateway to locate a gatekeeper. This sends out a request for a gatekeeper to a group of all the gatekeepers.

CHAR(1): Y/N (Default = N).

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

PRIORITY

Use when there are multiple gatekeepers for a gateway. It sets the order for the gateway to attempt to register with a gatekeeper. 127 is the lowest priority.

INTEGER: 0-127 (Default = 127).

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).

TIME-TO-LIVE (Obsolete in Release 4.4.1. Moved to H323 Gateway table in Release 4.4.1)

Time to live, in seconds.

INTEGER: 0-600 (Default = 60). 0 = infinite.


H.323 Terminal (Release 4.2)

The H.323 Terminal (h323-term) table holds information about H.323 terminals (such as H.323 audio/video phones) managed by the Call Agent and known in advance. This table is specific to H.323 subscribers.

Table Name: H323-TERM

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show h323-term id=video-phone1;
add h323-term; id=video-phone1; tsap-addr=64.101.150.50; h323-gw-id=gw1
change h323-term id=video-phone1, h323-gw-id=gw2; status=ueqp;
delete h323-term id=video-phone1,

Usage Guidelines

Primary Key Token(s): id

Foreign Key Token(s): h323-gw-id, h323-term-profile-id, sub-id

Unique Key Token(s): tsap-addr, alias-addr

Add Rules: None.

Change Rules: Cannot change a range of terminations.

Delete Rules: status=ueqp;

Syntax Description

* ID

Primary key. Identifies the H.323 terminal.

VARCHAR(16): 1-16 ASCII characters.

* H323-TERM-
PROFILE-ID

Mandatory if term-type=H323. Foreign key: H.323 Terminal Profile table. Specifies the id from the H.323 Terminal Profile table.

VARCHAR(16): 1-16 ASCII characters.

* TSAP-ADDR

Unique key. Specifies the IP address and port number of an H.323 phone (termination). This is required for H.323 subscribers.

Note Use the format: [a.b.c.d]:xyz. While the Domain name is supported, use with caution because the data is not internally cached.

VARCHAR(128): 1-128 ASCII characters. Permitted values are:

IP address in the format of [a.b.c.d]:xyz. The port (xyz) is optional

FQDN

ALIAS-ADDR

Unique key. The alias address of the H.323 endpoint as received in the sourceAddress field of a setup message. Used for various types of source-based routing methods as configured in the H.323 Gateway table.

VARCHAR(128): 1-128 ASCII characters. Permitted values are:

H323-ID

TRANSPORTID

EMAIL-ID

UK—Unknown

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

H323-GW-ID

Foreign key: H.323 Gateway table. Id of H.323 Gateway table entry used to route the outgoing H.323 call for this H323 terminal. If this is not configured, the Cisco BTS 10200 Softswitch chooses which H323-GW instance to use based on a load distribution algorithm.

VARCHAR(16): 1-16 ASCII characters (Default = NULL).

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).

STATUS

Status of the H.323 terminal. Used for inhibiting and allowing H.323 terminal calls. In Release 4.2 the control operation on an H.323 terminal does not impact H.323 external messaging to the phone or gatekeeper.

VARCHAR(15): 1-15 ASCII characters. Permitted values are:

UEQP (Default)—Unequipped

OOS—Out-of-Service

MAINT—Maintenance (Manual Override)

INS—In-Service

OOS-PENDING—Out of service state pending

MAINT-PENDING—Maintenance State Pending

SUB-ID (System generated)

Foreign key: Subscriber table. Subscriber ID of the line termination. Same as the ID in the Subscriber table.

VARCHAR(30): 1-30 ASCII characters.


H.323 Terminal Profile (Release 4.2)

The H.323 Terminal Profile (h323-term-profile) table defines the characteristics of group of H.323 terminals (or phones). An h323-term-profile id must be created in this table before any H.323 subscriber entries can be added. This table contains almost all the same fields as from the H.323 Trunk Group Profile table, except for some that are specific to trunk side (such as GTD).

Table Name: H323-TERM-PROFILE

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show h323-term-profile id=ras-sub;
add h323-term-profile id= ras-sub; ras=N;
change h323-term-profile id= ras-sub; ras=Y;
delete h323-term-profile id= ras-sub;

Usage Guidelines

Primary Key Token(s): id

Add Rules: FK constraints

If fax-pref-mode (in QOS table) = fax-t38-gwmode, then fax-t38-gwmode-supp=Y; (Obsolete in Release 4.5)

If fax-pref-mode (in QOS table) = fax-t38-camode, then fax-t38-camode-supp=Y; (Obsolete in Release 4.5)

If fax-pref-mode (in QOS table) = fax-inband, then fax- inband-supp=Y; (Obsolete in Release 4.5)

If dtmf-pref-mode (in QOS table) = dtmf-cisco-rtp, then dtmf-cisco-rtp-supp=Y; (Obsolete in Release 4.5)

If dtmf-pref-mode (in QOS table) = dtmf-h245-alpha, then dtmf-h245-alpha-supp=Y; (Obsolete in Release 4.5)

If dtmf-pref-mode (in QOS table) = dtmf-h245-signal, then dtmf-h245-signal-supp=Y; (Obsolete in Release 4.5)

If dtmf-pref-mode (in QOS table) = dtmf-rfc2833, then dtmf-rfc2833=Y; (Obsolete in Release 4.5)

If transport-pref-mode = udp-mode, then annexe-supp=Y;

If video-supp=Y, then H245-session-mode=AUTO or h245-flowaround.

Change Rules: None.

Delete Rules: None.

Syntax Description

* ID

Primary key. Unique id for this subscriber profile.

VARCHAR(16): 1-16 ASCII characters.

ANNEXE-SUPP

Indicates whether the trunk group supports Annex E.

CHAR(1): Y/N (Default = Y).

ANNEXR-SUPP (Not supported)

Flag indicates whether the trunk group supports AnnexR.

CHAR(1): Y/N (Default = N).

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

CALL-CONNECT-
MODE

Specifies the call setup method to use for outbound (for outbound trunk group) and inbound (for default inbound trunk group) H.323 calls.

Note If this field is configured as fast-start and the far-end H.323 does not support fast-start, the Cisco BTS 10200 Softswitch falls back to the slow-start method.

This token takes precedence over the call-start-mode in the H.323 Gateway table.

VARCHAR(10): 1-10 ASCII characters. Permitted values are:

AUTO (Default)—Use fast-start for calls originated from non-H.323 endpoints and outbound H.323 calls. For H.323 transit calls, use the same method for outbound H.323 calls as that of an inbound H.323 call.

FAST-START—Use FastConnect method for outbound H.323 calls (except where an incoming call is slow-start), regardless of the originating (inbound) call protocol type.

SLOW-START—Use the normal H.245 procedures during call setup, regardless of the originating (inbound) call protocol type.

CODEC-NEG-SUPP

Specifies whether a far-end H.323 device supports codec negotiation procedures to resolve an asymmetric codec condition. If this is configured as N, then the Cisco BTS 10200 Softswitch expects the far-end H.323 device (especially those not using a FastConnect procedure) to use the codec configured in the QOS entry in the Subscriber table.

CHAR(1): Y/N (Default = Y).

CUT-THRU-PARAM

Specifies the message parameter to use to perform media cut-thru. This configuration is used only for an incoming leg.

VARCHAR(10): 1-10 ASCII characters. Permitted values are:

AUTO (Default)—Use appropriate mode (H245-ADDR or PROG-IND) automatically based on incoming device type. Use H245-ADDR for Cisco CallManager and PROG-IND for all other devices.

H245-ADDR—The originating H.323 endpoint performs a media cut-thru on receipt of an H.245 address of an other-end (which is a Cisco BTS 10200 Softswitch for H.323 to non-H.323 calls, and a terminating H.323 endpoint for H.323 transit calls).

PROG-IND—Perform media cut-thru based on the Progress Indicator value as per interworking standards.

DESCRIPTION

Described by the service provider.

VARCHAR(64): 1-64 ASCII characters.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

DTMF-CISCO-RTP-
SUPP (Not supported)

Forwards DTMF tones by using Realtime Transport Protocol (RTP) with a Cisco proprietary payload type.

If all DTMF relay types are supported, the priority is as follows:

1. RFC2833

2. CISCO-RTP

3. H245-SIGNAL (Not used)

4. H245-ALPHA

CHAR(1): Y/N (Default = N).

DTMF-H245-ALPHA-SUPP

Forwards DTMF tones using the H.245 alphanumeric User Input Indication (UII) method. Tones 0 through 9, *, #, and A through D are supported. Use this keyword to configure the DTMF relay.

If all DTMF relay types are supported, the priority is as follows:

1. RFC2833

2. CISCO-RTP

3. H245-SIGNAL (Not supported)

4. H245-ALPHA

CHAR(1): Y/N (Default = N).

DTMF-H245-SIGNAL-SUPP

Forwards DTMF tones using the H.245 signal UII method. Tones 0 through 9, *, #, and A through D for H.323 to H.323 calls are supported.

If all DTMF relay types are supported, the priority is as follows:

1. RFC2833

2. CISCO-RTP

3. H245-SIGNAL (Not supported)

4. H245-ALPHA

CHAR(1): Y/N (Default = N).

DTMF-RFC2833

Forwards DTMF tones using RFC 2833.

If all DTMF relay types are supported, the priority is as follows:

1. RFC2833

2. CISCO-RTP

3. H245-SIGNAL (Not supported)

4. H245-ALPHA

CHAR(1): Y/N (Default = Y).

ECS-METHOD

Specifies the type of call flow to use to initiate a media pause from the Cisco BTS 10200 Softswitch.

Note According to specification, the H.323 device receiving an ECS message only closes its forward logical channel. The CCM, upon receiving an empty TCS message, assumes that a "reverse logical channel" will also be closed. But a later release can change this call flow to match standards.

VARCHAR(10): 1-10 ASCII characters. Permitted values are:

AUTO (Default)—For CCM, the Cisco BTS 10200 Softswitch uses the all-pause method. For all other types of H.323 devices, the Cisco BTS 10200 Softswitch uses the local-pause method.

LOCAL-PAUSE—The far-end (H.323 device receiving the ECS message) closes the forward logical channel.

ALL-PAUSE—The far-end (H.323 device receiving the ECS message) closes the forward logical channel. The local (Cisco BTS 10200 Softswitch) side also closes its forward logical channel.

FACILITY-SUPP

Specifies whether a far-end H.323 endpoint (for both incoming as well as outgoing leg) supports facility messages.

Note Set to N for CCM.

CHAR(1): Y/N (Default = Y).

FAX-T38-CAMODE-
SUPP (Obsolete in Release 4.5)

Specifies if this is a Call Agent controlled (Call Agent instructs gateway to switch to T.38 mode) relay in real time.

CHAR(1): Y/N (Default = Y).

FAX-T38-GWMODE-
SUPP (Obsolete in Release 4.5)

Specifies if this is a gateway-controlled (using NSE to switch to T.38 mode) relay in real time.

CHAR(1): Y/N (Default = N).

H245-SESSION-
MODE

Specifies the type of H.245 channel establishment procedure to use for H.323 to H.323 calls. For H.323 to non-H.323 calls, H245-FLOWTHRU mode is used.

VARCHAR(16): 1-16 ASCII characters. Permitted values are:

AUTO (Default)—For H.323 to H.323 calls, with both sides supporting video, use the H245-FLOWAROUND mode; otherwise use H245-FLOWTHRU mode.

H245-FLOWAROUND—The H.323 originating and terminating endpoints will establish the H.245 session without Cisco BTS 10200 involvement. Applies only to slow-start to show-start calls.


Caution Cisco does not recommend using this value. Media information in the CDR is not accurate in this mode.

H245-FLOWTHRU—Terminate and reoriginate the H.245 session for H.323 transit calls.

H245-TUNNELING

Specifies the H.245 tunneling mode to be used. When H.245 tunneling is enabled, all H.245 messages are tunneled inside a facility message instead of a separate H.245 TCP channel.

VARCHAR(8): 1-8 ASCII characters. Permitted values are:

AUTO (Default)—Default H.245 tunneling operation. Use H.245 tunneling for calls between H.323 and non-H.323 endpoints. For H.323 transit calls, use the same method for outgoing calls as that of incoming calls.

ENABLE—Use H.245 tunneling for outgoing calls, without considering the type of incoming call leg protocol.

DISABLE—Disable H.245 tunneling for the outgoing call leg and use a separate H.245 TCP channel.

H323-TCP-TIMER

The H.323 TCP timeout value in seconds.

INTEGER: Range 1-30 (Default = 10).

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

MAX-CALLS

Specifies the maximum number of calls allowed on the H.323 terminal. When the current number of calls exceed this number, any call termination to this terminal results in a "busy" condition, and can trigger the CFB or CW feature if CFB or CW is configured for the subscriber.

INTEGER: 1-6 (Default = 2).

MISC-UNSUPP (Release 4.2; Obsolete in Release 4.5)

Specifies whether to suppress sending of a FastStart element in a Call Proceeding message (SUPPRESS-CP-FS). This token is available for this purpose only in Releases 4.2, 4.4.0/1. As of Release 4.5, this field is replaced by the SEND-CALL-PROCEEDING token.

NUMERIC: 0-65535 (Default = 0).

To determine the correct value for this token, see Table 7-1: How to Determine Misc-unsupp Token Values.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

RAS

Registration, Admission, and Status.

CHAR(1): Y/N (Default = Y).

REMOTE-FAX-PORT- RETRIEVAL-MSG (Release 4.5)

Specifies whether the remote H.323 gateway reports a UDP Port for a T38 fax transmission in an H.245 Open Logical Channel (OLC) message or in an Open Logical Channel Acknowledge message (OLCAck). All Cisco IOS H.323 gateways report it in the OLC message itself.

VARCHAR(16): 1-16 ASCII characters. Permitted values are:

H245-OLC (Default)

H245-OLC-ACK

SEND-CALL-
PROCEEDING

Specifies when to send a call proceeding message in a backward direction on an incoming trunk group.

Note Not applicable for incoming calls from an H.323 network to local a subscriber controlled by the Cisco BTS 10200 Softswitch that are being forwarded or transferred to an H.323 network.

VARCHAR(10): 1-10 ASCII characters.

AUTO—Send H.323 to non-H.323 calls locally; send end-to-end for H.323 to H.323 calls.

LOCAL—Send locally regardless of outgoing call protocol type.

DISABLE—Never send a call proceeding message.

SEND-DEST-
CIRCUIT-ID

Specifies whether to send a destination circuit id in an outgoing H.323 call message and use a destination circuit id from an incoming message

For outgoing H.323 calls, if this field is configured as Y, the Cisco BTS 10200 Softswitch sends an SP-ID configured for the outgoing trunk group in the destCircuitInfo field of the outgoing admission request (ARQ) and setup messages.

CHAR(1): Y/N (Default = N).

SEND-FS-CALLP (Release 4.5)

Sends the FastStart element in a call proceeding message if available. Otherwise, sends the FastStart element in a call alerting or progress message depending on which is sent first.

CHAR(1): Y/N (Default = N).

SEND-SRC-CIRCUIT-
ID

Specifies whether to send an outgoing trunk subgroup or source circuit id in an outgoing H.323 call message and use the source circuit id from an incoming call.

CHAR(1): Y/N (Default = N).

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).

TRANSPORT-PREF-
MODE

Specifies what transport layer protocol to use to transmit H.323 signaling messages.

VARCHAR(8): 1-8 ASCII characters. Permitted values are:

TCP-MODE—Use TCP to transport messages.

UDP-MODE (Default)—Use Annex E udp-based message transport facility. If the remote endpoint does not support UDP, the Cisco BTS 10200 Softswitch falls back to TCP.

VIDEO-SUPP

Specifies whether the H.323 subscriber phone is video capable. This field is also used to fill in the CDR.

CHAR(1): Y/N (Default = N).


H.323 Trunk Group Profile

The H.323 Trunk Group Profile (h323-tg-profile) table defines the characteristics of each H.323 trunk. An h323-tg-profile id must be created in this table before H.323 trunk group entries can be added.

Table Name: H323-TG-PROFILE

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show h323-tg-profile id=ras-tg;
add h323-tg-profile id= ras-tg; ras=n;
change h323-tg-profile id= ras-tg; ras=y;
delete h323-tg-profile id= ras-tg;

Usage Guidelines

Primary Key Token(s): id

Add Rules:

If fax-pref-mode=FAX-T38-CAMODE, then fax-t38-camode-supp=Y; (Obsolete in Release 4.5)

if transport-pref-mode=UDP-MODE, then annexe-supp=Y; (Obsolete in Release 4.5)

if h245-tunneling = AUTO or ENABLE, then facility-supp=Y; (Obsolete in Release 4.5)

if video-supp=Y, then h245-session-mode=AUTO or H245-FLOWAROUND

if transport-pref-mode = UDP-MODE, then annexe-supp=Y; (Release 4.5)

if h245-tunneling = AUTO or ENABLE, then facility-supp is Y. (Release 4.5)

if video-supp = Y, then h245-session-mode=AUTO or H245-FLOWAROUND (Release 4.5)

Change Rules: None.

Delete Rules: None.

Misc-unsupp Rules:

Use Table 7-1 to determine the correct value for the misc-unsupp token.

Table 7-1 How to Determine Misc-unsupp Token Values

Scenario
Set to
Set to
Set to
Set to
Set to
Set to
Set to
Set to

SUPPRESS-CP-FS

N

Y

N

N

Y

Y

N

Y

SUPPRESS-CCM-BC

N

N

Y

N

Y

N

Y

Y

NO-INTERWORKING-
ENCOUNTERED

N

N

N

Y

N

Y

Y

Y

Set the MISC-UNSUPP to:

0 (Default)

1

2

4

3

5

6

7


Syntax Description

* ID

Primary key. Unique ID for this trunk group profile.

VARCHAR(16): 1-16 ASCII characters.

ECS-METHOD (Release 4.2)

Specifies the type of call flow to use for initiating a media pause from the Cisco BTS 10200 Softswitch. The CCM, upon receiving an empty TCS message, assumes that a "Reverse logical channel" will also be closed.

Note According to specification, the H.323 device receiving an ECS message only closes its forward logical channel.

VARCHAR(15): 1-15 ASCII characters. Permitted values are:

AUTO (Default)—For CCM, the Cisco BTS 10200 Softswitch uses the ALL-PAUSE method and for all other types of H.323 devices, uses LOCAL-PAUSE method.

LOCAL-PAUSE—The far-end (H.323 device receiving the ECS message) closes the forward logical channel.

ALL-PAUSE—The far-end (H.323 device receiving the ECS message) closes the forward logical channel.

Note The local (Cisco BTS 10200 Softswitch) side also closes its forward logical channel.

ANNEXE-SUPP

Specifies whether this trunk group supports Annex E.

CHAR(1): Y/N (Default = Y).

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

CALL-CONNECT-
MODE (Release 4.2)

Call setup method used for outbound (for outbound trunk group) and inbound (for default inbound trunk group) H.323 calls.

Note If this field is configured as fast-start and the far-end H.323 endpoint does not support fast-start, the Cisco BTS 10200 Softswitch falls back to the slow-start method.

This token takes precedence over the call-start-mode token in the H.323 Gateway table.

VARCHAR(10): 1-10 ASCII characters. Permitted values are:

AUTO (Default)—Use fast-start for calls originated from non-H.323 endpoint and outbound H.323 calls. For H.323 transit calls, use the same method for outbound H.323 calls as that of inbound H.323 call.

FAST-START—Always use the fastConnect method for outbound H.323 calls (except where an incoming call is a slow-start), regardless of originating (inbound) call protocol type.

SLOW-START—Always use the normal H.245 procedures during call setup, regardless of originating (inbound) call protocol type.

CODEC-NEG-SUPP (Release 4.2)

Specifies whether the far-end H.323 device supports codec negotiation procedures to resolve asymmetric codec conditions.

If this is configured as N, then the Cisco BTS 10200 Softswitch expects the far-end H323 device (especially those not using a fastConnect procedure) to use a codec configured in the QOS table entry of the Trunk Group table.

Note For all Cisco IOS gateways, set this token to Y. For older versions of CCM, set this token to N.

CHAR(1): Y/N (Default = Y).

CUT-THRU-PARAM (Release 4.2)

Specifies what message parameter to use to perform a media cut-thru. This configuration is used only for an incoming leg.

VARCHAR(10): 1-10 ASCII characters. Permitted values are:

AUTO (Default)—Use appropriate mode (H245-ADDR or PROG-IND) automatically based on incoming device type. Uses H245-ADDR for Cisco Call Manager and PROG-IND for all other devices.

H245-ADDR—The originating H.323 endpoint performs media cut-thru on receipt of H.245 address of other-end (the Cisco BTS 10200 Softswitch for H.323 to non-H.323 calls, and terminating H.323 endpoint for H.323 transit calls).

PROG-IND—The media cut-thru is done based on the Progress Indicator value as per interworking standard.

DESCRIPTION (EMS-only field)

Described by the service provider.

VARCHAR(64): 1-64 ASCII characters.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

DTMF-CISCO-RTP-
SUPP (Not used)

Forwards DTMF tones using the Realtime Transport Protocol (RTP) with a Cisco proprietary payload type.

CHAR(1): Y/N (Default = N).

If all DTMF relay types are supported, the priority is:

1. RFC2833

2. CISCO-RTP

3. H245-SIGNAL (Not used)

4. H245-ALPHA

DTMF-H245-ALPHA-SUPP

Specifies if the trunk group forwards DTMF tones using the H.245 alphanumeric User Input Indication (UII) method. It supports tones 0 through 9, *, #, and A through D. Use this token to configure a DTMF relay.

When this type of DTMF relay is supported, the Call Agent controls the relay. The originating trunk group reports to the Call Agent, which then passes the DTMF tones on to the terminating trunk group.

CHAR(1): Y/N (Default = Y).

If all DTMF relay types are supported, the priority is:

1. RFC2833

2. CISCO-RTP

3. H245-ALPHA

DTMF-H245-SIGNAL-SUPP (Release 4.2)

Specifies if the trunk group forwards DTMF tones using the H.245 signal UII method. It supports tones 0 through 9, *, #, and A through D.

CHAR(1): Y/N (Default = N).

DTMF-RFC2833

Specifies if the trunk group forwards DTMF tones directly on the bearer path using RFC 2833. The DTMF tones do not go through the Call Agent.

CHAR(1): Y/N (Default = N).

FACILITY-SUPP (Release 4.2)

Specifies whether the far-end H.323 endpoint (for both incoming as well as outgoing leg) supports facility messages.

Note Set to N for CCM.

CHAR(1): Y/N (Default = Y).

FAX-T38-CAMODE-
SUPP (Obsolete in Release 4.5)

Default. Call Agent controlled (CA instructs GW to switch to T.38 mode), relay in real time.

CHAR(1): Y/N (Default = N).

FAX-T38-GWMODE-SUPP (Obsolete in Release 4.5)

Gateway controlled (using NSE to switch to T.38 mode), relay in real time.

CHAR(1): Y/N (Default = N).

H245-SESSION-
MODE

Specifies the type of H.245 channel establishment procedure to use for H.323 to H.323 calls. For H.323 to non-H.323 calls the H245-FLOWTHRU mode is used.

VARCHAR(16): 1-16 ASCII characters. Permitted values are:

AUTO (Default)—For H.323 to H.323 calls both side supporting video, use the H245-FLOWAROUND mode; otherwise use H245-FLOWTHRU mode.

H245-FLOWAROUND—The H.323 originating and terminating endpoints will establish the H.245 session without any Cisco BTS 10200 Softswitch involvement. This applies only to slow-start to show-start calls.


Caution Cisco does not recommend using this value. Media information in the CDR is not accurate in this mode.

H245-FLOWTHRU (Not used)—Always terminate and reoriginate the H.245 session for H.323 transit calls. This is the default mode when the Cisco BTS 10200 Softswitch can perform H245-FLOWTHRU mode for video calls.

H245-TUNNELING (Release 4.2)

Specifies the H.245 tunneling mode to use. When H.245 tunneling is enabled, all H.245 messages are tunneled inside a facility message instead of through a separate H.245 TCP channel.

VARCHAR(8): 1-8 ASCII characters. Permitted values are:

AUTO (Default)—Default H.245 tunneling operation. Use H.245 tunneling for calls between H.323 and non-H.323. For H.323 transit calls, use same method for outgoing as that of incoming calls.

ENABLE—Always use H.245 tunneling for outgoing calls, without considering the type of incoming call leg protocol.

DISABLE—Always disable H.245 tunneling for outgoing call legs and use a separate H.245 TCP channel.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

MISC-UNSUPP (Release 4.5)

This token is used in combination for the following scenarios:

SUPPRESS-CP-FS—Specify whether to suppress sending of a FastStart element in a Call Proceeding message. This scenario is available only in Releases 4.2, 4.4.0/1. As of Release 4.5, this field is replaced by SEND-CALL-PROCEEDING field.)

SUPPRESS-CCM-BC—Specify whether to suppress Bearer Capability information received in Setup message from Cisco Call Manager. (tg-profile)

NO-INTERWORKING-ENCOUNTERED—Specify how to encode the "interworking encountered" parameter towards the incoming call leg when an ALERTING message is received from an H.323 trunk interface.

Y—(None) the connection mode is "recvonly."

N—(Avail) the connection mode is "sendrecv." Note that for H.323 terminals this field is always assumed to be Y (None) as per interworking specifications

NUMERIC: 0-65535 (Default = 0).

To determine the correct value for this token, see Table 7-1: How to Determine Misc-unsupp Token Values.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

RAS

Specifies whether this trunk (H.323 gateway) uses the gatekeeper for Registration, Administration, and Status (RAS).

CHAR(1): Y/N (Default = Y).

Y—All address resolution and translation is done by the gatekeeper.

NAll address resolution and translation is done by the Call Agent. If this is used, configure the softsw-tsap-addr token in the Trunk Group table for the correct destination gateway.

REMOTE-FAX-PORT- RETRIEVAL-MSG (Release 4.5)

Specifies whether the remote H.323 gateway reports a UDP Port for a T38 fax transmission in an H.245 Open Logical Channel (OLC) message or in an Open Logical Channel Acknowledge message (OLCAck). All Cisco IOS H.323 gateways report it in the OLC message itself.

VARCHAR(16): 1-16 ASCII characters. Permitted values are:

H245-OLC (Default)

H245-OLC-ACK

SEND-CALL-
PROCEEDING (Release 4.2)

This configuration on an incoming trunk group controls the behavior of when to send a call proceeding message in a backward direction.

Note Not applicable for incoming calls from an H.323 network to local a subscriber controlled by the Cisco BTS 10200 Softswitch that are being forwarded or transferred to an H.323 network.

VARCHAR(15): 1-15 ASCII characters. Permitted values are:

AUTO (Default)—Send locally for H.323 to non-H.323 calls; send end-to-end for H.323 to H.323 calls.

LOCAL—Always send locally regardless of outgoing call protocol type.

DISABLE—Never send a call proceeding message.

SEND-DEST-
CIRCUIT-ID (Release 4.2)

Specifies whether to send the destination circuit id in the outgoing H.323 call message and use the destination circuit id from incoming H.323 call message.

For outgoing H323 calls, if this field is set to Y, the Cisco BTS 10200 Softswitch sends the SP-ID configured for outgoing trunk group in the destCircuitInfo field of the outgoing ARQ and setup messages.

CHAR(1): Y/N (Default = N).

SEND-FS-CALLP (Release 4.5)

Specifies what message to send a FastStart element in.

CHAR(1): Y/N (Default = Y).

Y—Send in a call proceeding message if available. If a call proceeding message is not available, element is sent in a call alerting or progress message.

N—Send in a call alerting or progress message (depending on which is sent first).

SEND-SRC-CIRCUIT-ID (Release 4.2)

Specifies whether to send the outgoing trunk subgroup or source circuit id in the outgoing H.323 call message.

CHAR(1): Y/N (Default = N).

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).

TRANSPORT-PREF-MODE

Specifies what transport layer protocol to use to transmit H.323 signaling messages.

VARCHAR(8): 1-8 ASCII characters. Permitted values are:

TCP-MODE (Default)—Use TCP to transport messages.

UDP-MODE—Use the Annex E UDP-based message transport facility. If the remote endpoint does not support UDP, Cisco BTS 10200 falls back to TCP.

VIDEO-SUPP (Release 4.2)

Specifies whether the H.323 trunk-group is video capable or not. If the Cisco BTS 10200 Softswitch is connected to a far-end H.323 gateway in a video-enabled network, enable this field for both incoming and outgoing trunk groups.

Note This field is also used to fill in the CDR.

CHAR(1): Y/N (Default = N).


II White Black List

The II White Black List (ii-wb-list) table allows or blocks calls from certain types of lines. The COS Restrict ID specifies if the list is to be used as a White List or Black List.

Table Name: II-WB-LIST

Table Containment Area: FSPTC

Command Types

Show, add, and delete

Examples

show ii-wb-list cos-restrict-id=20;
add ii-wb-list cos-restrict-id=20; 
delete ii-wb-list cos-restrict-id=20;

Usage Guidelines

Primary Key Token(s): cos-restrict-id

Foreign Key Token(s): cos-restrict-id

Add Rules: None.

Delete Rules: None.

Syntax Description

* COS-RESTRICT-ID

Primary key. Foreign key: COS Restrict table. Use for class of service (COS) blocking of certain calls.

VARCHAR(16): 1-16 ASCII characters.

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

II1

The originating line information (OLI) to be screened as White Black List is specified. Specify up to 10 OLI tokens. Set a default value of 255 (invalid) if the OLI token is not used.

SMALLINT: 0-99 (Default = 255).

II10

The OLI to be screened as White Black List is specified. Specify up to 10 OLI tokens. Set a default value of 255 (invalid) if the OLI token is not used.

SMALLINT: 0-99 (Default = 255).

II2

The OLI to be screened as White Black List is specified. Specify up to 10 OLI tokens. Set a default value of 255 (invalid) if the OLI token is not used.

SMALLINT: 0-99 (Default = 255).

II3

The OLI to be screened as White Black List is specified. Specify up to 10 OLI tokens. Set a default value of 255 (invalid) if the OLI token is not used.

SMALLINT: 0-99 (Default = 255).

II4

The OLI to be screened as White Black List is specified. Specify up to 10 OLI tokens. Set a default value of 255 (invalid) if the OLI token is not used.

SMALLINT: 0-99 (Default = 255).

II5

The OLI to be screened as White Black List is specified. Specify up to 10 OLI tokens. Set a default value of 255 (invalid) if the OLI token is not used.

SMALLINT: 0-99 (Default = 255).

II6

The OLI to be screened as White Black List is specified. Specify up to 10 OLI tokens. Set a default value of 255 (invalid) if the OLI token is not used. SMALLINT: 0-99 (Default = 255).

II7

The OLI to be screened as White Black List is specified. Specify up to 10 OLI tokens. Set a default value of 255 (invalid) if the OLI token is not used.

SMALLINT: 0-99 (Default = 255).

II8

The OLI to be screened as White Black List is specified. Specify up to 10 OLI tokens. Set a default value of 255 (invalid) if the OLI token is not used.

SMALLINT: 0-99 (Default = 255).

II9

The OLI to be screened as White Black List is specified. Specify up to 10 OLI tokens. Set a default value of 255 (invalid) if the OLI token is not used.

SMALLINT: 0-99 (Default = 255).

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).


Service Provider

The Service Provider (service-provider) table is used when there are multiple service providers providing service via a single logical Call Agent.

Table Name: SERVICE-PROVIDER

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show service-provider id=grp1; 
add service-provider id=grp1;dial-plan-id=dp1;
change service-provider id=grp1;dial-plan-id=gw1dp;
delete service-provider id=grp1;

Usage Guidelines

Primary Key Token(s): id

Foreign Key Token(s): dial-plan-id, route-guide-id

Add Rules: Foreign key constraints, dial-plan-id is required if sp-based-routing=y.

Change Rules: Foreign key constraints.

Delete Rules: Foreign key constraints.

Syntax Description

* ID

Primary key. Service provider ID: a unique identifier for this customer group. Assigned by service provider.

VARCHAR(16): 1-16 ASCII characters.

ANI-WB-LIST (Not supported)

Indicates if White / Black List ANI screening is required. Defines how the ani-wb-list is to be used to screen the calling number: as a white list, black list, or not at all.

CHAR(5): 1-5 characters. Permitted values are:

NONE (Default)—No ANI screening is performed.

WHITE—ani-wb-list is used as a white list.

BLACK—ani-wb-list is used as a black list.

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DESCRIPTION (EMS-only field)

Described by service provider.

VARCHAR(64): 1-64 ASCII characters.

DIAL-PLAN-ID

Foreign key: Dial Plan Profile table. Use this dial plan ID for NANP routing and use the international dial plan ID defined in the Dial Plan Profile table for routing international calls.

VARCHAR(16): 1-16 ASCII characters.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

ROUTE-GUIDE-ID

Foreign key: Route Guide table. Defines the default route for service provider.

VARCHAR(16): 1-16 ASCII characters.

SP-BASED-ROUTING

Specifies whether routing is service-provider based.

CHAR(1): Y/N (Default = N).

Y—Use the dial plan specified in this table for routing (if no match is found, proceed as if service-provider based routing was set to N).

N—Perform routing based on the use-dial-plan token in this table.

Note To use service-provider routing, the set the traffic type specified in the trunk group table to TANDEM.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).

USE-DIAL-PLAN

Use this token when the service provider is acting as a long-distance carrier. If an on-net route exists to a dialed number based on the dial-plan-id, the route-guide pointing to the on-net route is provisioned in the Destination table. If an on-net route does not exist in the Dial Plan, the route is determined based on this flag.

CHAR(1): Y/N (Default = Y).

Y (Default)—Use the default dial plan for routing if there is no match in the SP dial plan, or if sp-based-routing = N.

N—Use default route defined in this table for routing if there is no match in the SP dial plan, or if sp-based-routing = N.


Technical Prefix Group

The Technical Prefix Group (tech-prefix-grp) table provides a list of technical prefixes supported by a gateway. The same tech-prefix-list ID can be shared by multiple gateways. Each gateway must register the tech-prefixes supported to their respective gatekeepers.

Technical prefixes allow the inclusion of special characters in a called number. These special characters are commonly designated as a 1#, 2#, 3#, and so forth, and can be configured to prepend called number on the outgoing VoIP dial peer. The gatekeeper then checks its gateway technical prefix table for gateways registered with that particular tech prefix. Technology prefixes can also be used to identify a type, class, or pool of gateways.

The gatekeeper can be provisioned with technical prefixes in one of the following ways:

Dynamically registered technical prefixes. The H.323 gateway registers one or more technical prefixes with the gatekeeper.

Statically registered technical prefixes. The gatekeeper is provisioned with the technical prefixes and the gateways supporting them.

Default technical prefixes also registered statically at the gatekeeper. If the gatekeeper does not receive a technical prefix in the ARQ, the gatekeeper uses the default technical prefixes.

A group of one or more of technical prefixes can be provisioned in Cisco BTS 10200 Softswitch and this group can be associated to an H.323 gateway. The Cisco BTS 10200 Softswitch H.323 gateway process instance registers the technical prefixes from its technical prefix group with its primary gatekeeper. The technical prefix is encoded in the terminalalias field of an RRQ message as E.164 addresses. The gatekeeper routes calls to the Cisco BTS 10200 Softswitch H.323 gateway based on the technical prefixes.

Table Name: TECH-PREFIX-GRP

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show tech-prefix-grp id=grp1; tech-prefix=1#;
add tech-prefix-grp id=grp1; tech-prefix=1#; sp-id=sp1;
change tech-prefix-grp id=grp1; tech-prefix=1#; sp-id=sp2;
delete tech-prefix-grp id=grp1; tech-prefix=1#;

Usage Guidelines

Primary Key Token(s): id, tech-prefix

Foreign Key Token(s): id, tech-prefix

Add Rules: Foreign key constraints. Tech-prefix-grp id must exist.

Change Rules: Foreign key constraints.

Delete Rules: Foreign key constraints.

Use tech-prefix based routing. If no tech prefix is received, use the dial plan id in the H.323 Gateway table.

Use tech-prefix based SP-ID. If entry is found, continue.

If no entry is found in the tech-prefix-grp table, use the dial plan id specified in the H.323 gateway table to route the call.

Syntax Description

* ID

Primary key. Foreign key: Technical Prefix Group Profile table. Technical prefix group ID.

VARCHAR(16): 1-16 ASCII characters.

* SP-ID

Foreign key: Service Provider table. The service provider ID.

VARCHAR(16): 1-16 ASCII characters.

* TECH-PREFIX

Primary key. Specifies carrier-sensitive routing for H.323 networks.

VARCHAR(11): 1-11 ASCII characters. Valid characters are [0-9],*, #

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).


Technical Prefix Group Profile

The Technical Prefix Group Profile (tech-prefix-grp-profile) table identifies the IDs used for the Technical Prefix Group table. These IDs must be created in this table before entries can be added to the Technical Prefix Group table.

Table Name: TECH-PREFIX-GRP-PROFILE

Table Containment Area: EMS only

Command Types

Show, add, and delete

Examples

show tech-prefix-grp-profile id=grp1;
add tech-prefix-grp-profile id=grp1;
delete tech-prefix-grp-profile id=grp1;

Usage Guidelines

Primary Key Token(s): id

Add Rules: None.

Delete Rules: None.

Syntax Description

* ID

Primary key. Technical prefix group ID. Determined by service provider.

VARCHAR(16): 1-16 ASCII characters.

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DESCRIPTION (EMS-only field)

Described by service provider.

VARCHAR(64): 1-64 ASCII characters.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).


Trunk Group Feature Data

The Trunk Group Feature Data (trunk-grp-feature-data) table performs class of service (COS) screening for Tandem calls. If the received automatic number identification (ANI) is not found in the ANI table, and the casual-call flag is set to Y, the call is allowed. If the casual-call flag is set to N, the call is blocked. The cos-restrict-id performs the COS screening.

Table Name: TRUNK-GRP-FEATURE-DATA

Table Containment Area: FSPTC

Command Types

Show, add, change, and delete

Examples

show trunk-grp-feature-data tgn-id=101;
add trunk-grp-feature-data tgn-id=101;
change trunk-grp-feature-data tgn-id=101; casual-call=n;
delete trunk-grp-feature-data tgn-id=101;

Usage Guidelines

Primary Key Token(s): tgn-id

Foreign Key Token(s): tgn-id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* TGN-ID (or * TG)

Primary key. Foreign key: Trunk Group table. Trunk group ID.

This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it.

INTEGER: 1-99999999.

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

CASUAL-CALL

Specifies if casual calls are allowed over this trunk group. Used to block calls that arrive without an ANI. Customers can place casual calls by dialing a special 7-digit access code (101xxxx—where xxxx can be a 4-digit carrier code, or 0xxx for a 3-digit carrier code) before the area code and telephone number.

CHAR(1): Y/N (Default = Y).

Y—Casual calls are allowed.

N—Casual calls are not allowed.

COS-RESTRICT-ID

Foreign key: COS Restrict table. ID from COS Restrict table.

VARCHAR(16): 1-16 ASCII characters.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).


Trunk Group Service Profile

The Trunk Group Service Profile (trunk-grp-service-profile) table links a trunk group to services.

Table Name: TRUNK-GRP-SERVICE-PROFILE

Table Containment Area: Call Agent, Tandem Feature Server

Command Types

Show, add, change, and delete

Examples

show trunk-grp-service-profile tgn-id=101; service-id= 2;
add trunk-grp-service-profile tgn-id=101; service-id= 2; priority=1;
change trunk-grp-service-profile tgn-id=101; service-id= 2; priority=2;
delete trunk-grp-service-profile tgn-id=101; service-id= 2;

Usage Guidelines

Primary Key Token(s): tgn-id, service-id

Foreign Key Token(s): tgn-id, service-id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* TGN-ID (or * TG)

Primary key. Foreign key: Trunk Group table. Trunk group ID. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it.

INTEGER: 1-99999999.

* SERVICE-ID

Primary key. Foreign key: Service table. The number of service-ids that can be assigned to a trunk-grp is limited to 50. Must match valid service-id in the Service table.

VARCHAR(16): 1-16 ASCII characters.

AUTO-REFRESH

Specifies whether to display cached data on the screen. Valid only for the show command.

CHAR(1): Y/N (Default = Y).

Y—Queries the database for the most current data.

N—Queries the database for the most current data only if the cached data is unavailable.

DISPLAY

Specifies what token information to display on the screen. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

LIMIT

Specifies the number of rows to display on the screen. Valid only for the show command.

INTEGER: 1-100000000 (Default = 100000000).

Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.

ORDER

Specifies whether to display data on the screen in a sorted order. Valid only for the show command.

VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.

PRIORITY

Priority is used if there are multiple services assigned to a trunk group. The service with higher priority is processed first before the service with a lower priority. Priority 1 being the highest.

SMALLINT: 1-10 (Default = 1).

START-ROW

Specifies to begin displaying data on the screen at a specific row. Valid only for the show command.

INTEGER: 1-100000000 (Default = 1).