|
|
Table Of Contents
Configuration Text File Template
User Interface (UI) Security Parameter
Parameters for Configuration Method and Encryption
Network Configuration Parameters
Audio Configuration Parameters
Telephone Configuration Parameters
Tone Parameter Syntax—Basic Format
Tone Parameter Syntax—Extended Formats
Specific Tone Parameter Information
CFGID—Version Parameter for Cisco ATA Configuration File
Parameters and Defaults
This section provides information on the parameters and defaults that you can use to create your own Cisco ATA configuration file. This section also includes the voice configuration menu code for each parameter that has such a code.
Parameters are divided into categories based on their functionality. The following categories of parameters are covered in this section:
•
User Interface (UI) Security Parameter
•
•
•
•
•
•
The following list contains general configuration information:
•
•
–
–
–
–
Note
Note
–
–
–
–
Note
Note
Configuration Text File Template
This is a listing of the h323_example.txt text file, without its annotations, that comes bundled with the Cisco ATA software.
You can make a copy of this file and use it as a template for creating your own default configuration file or Cisco ATA-specific configuration file. For instructions on how to create these configuration files, see the "Creating Unique and Common Cisco ATA Configuration Files" section on page 3-9.
The h323_example.txt file contains all the Cisco ATA default values. The sections that follow this listing describe all the parameters in this file.
#txtUIPassword:0UseTftp:1TftpURL:0cfgInterval:3600EncryptKey:0EncryptKeyEx:0upgradecode:0,0x301,0x0400,0x0200,0.0.0.0,69,0,noneupgradelang:0,0x301,0x0400,0x0200,0.0.0.0,69,0,noneDhcp:1StaticIp:0StaticRoute:0StaticNetMask:0NTPIP:0.0.0.0AltNTPIP:0.0.0.0DNS1IP:0.0.0.0DNS2IP:0.0.0.0VLANSetting:0x0000002bGkOrProxy:0GkId:.GkTimeToLive:0AltGk:0AltGkTimeOut:0UID0:0UID1:0UseLoginID:0LoginID0:0LoginID1:0PWD0:0PWD1:0AutMethod:0x00000000GateWay:0MediaPort:16384RxCodec:1TxCodec:1LBRCodec:0AudioMode:0x00150015NumTxFrames:2TOS:0x0000A8B8CallFeatures:0xffffffffPaidFeatures:0xffffffffCallCmd:Af;AH;BS;NA;CS;NA;Df;EB;Ff;EP;Kf;EFh;HH;Jf;AFh;HQ;I*67;gA*82;fA#90v#;OI;H#72v#; bA#74v#;cA#75v#;dA#73;eA*67;gA*82;fA*70;iA*69;DA*99;xA;Uh;GQ;FeatureTimer:0x00000000FeatureTimer2:0x0000001eSigTimer:0x01418564ConnectMode:0x00060400OpFlags:0x00000002TimeZone:17CallerIdMethod:0x00019e60Polarity: 0FXSInputLevel:-1FXSOutputLevel:-4DialTone:2,31538,30831,1380,1740,1,0,0,1000BusyTone:2,30467,28959,1191,1513,0,4000,4000,0ReorderTone:2,30467,28959,1191,1513,0,2000,2000,0RingBackTone:2,30831,30467,1943,2111,0,16000,32000,0CallWaitTone:1,30831,0,5493,0,0,2400,2400,4800AlertTone:1,30467,0,5970,0,0,480,480,1920RingOnOffTime:2,4,25DialPlan:*St4-|#St4-|911|1>#t8.r9t2-|0>#t811.rat4-|^1t4>#.-IPDialPlan: 1NPrintf:0TraceFlags:0x00000000SyslogIP:0.0.0.0.514SyslogCtrl:0x00000000The sections that follow describe these parameters.
User Interface (UI) Security Parameter
This section contains only one parameter—UIPassword.
UIPassword
Description
This parameter controls access to web page or voice configuration menu interface. To set a password, enter a value other than zero. To have the user prompted for this password when attempting to perform a factory reset or upgrade using the voice configuration menu, see the "OpFlags" section.
To clear a password, change the value to 0.
You cannot recover a forgotten password unless you reset the entire configuration of the Cisco ATA (see the "Resetting the Cisco ATA to Factory Default Values" section on page 3-23).
Note
Value Type
Alphanumeric string
Range
Maximum nine characters
Default
0
Voice Configuration Menu Access Code
7387277
Related Parameter
OpFlags—Bit 7
Parameters for Configuration Method and Encryption
This section describes parameters for instructing the Cisco ATA about how to locate its TFTP server and how to encrypt its configuration file:
•
•
UseTFTP
Settings
1—Use the TFTP server for Cisco ATA configuration.
0—Do not use the TFTP server for Cisco ATA configuration.
Value Type
Boolean
Range
0 or 1
Default
1
Voice Configuration Menu Access Code
305
Related Parameters
•
•
TftpURL
Description
Use this parameter to specify the IP address or URL of the TFTP server. This string is needed if the DHCP server does not provide the TFTP server IP address. When the TftpURL parameter is set to a non-zero value, this parameter has priority over the TFTP server IP address supplied by the DHCP server.
Optionally, you can include the path prefix to the TFTP file to download.
For example, if the TFTP server IP address is 192.168.2.170 or www.cisco.com, and the path to download the TFTP file is in /ata186, you can specify the URL as 192.168.2.170/ata186 or www.cisco.com/ata186.
Note
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
905
Related Parameters
•
CfgInterval
Description
Use this parameter to specify the number of seconds between each configuration update. The Cisco ATA will also upgrade its signaling image if it detects that the TFTP server contains an upgraded image.
For example, when using TFTP for configuration, the Cisco ATA contacts TFTP each time the interval expires to get its configuration file.
You can set CfgInterval to a random value to achieve random contact intervals from the Cisco ATA to the TFTP server.
Value Type
Decimal
Range
60 to 4294967295
Default
3600
Voice Configuration Menu Access Code
80002
Related Parameters
•
•
EncryptKey
Description
This parameter specifies the encryption key that is used to encrypt the Cisco ATA configuration file on the TFTP server.
The cfgfmt tool, which is used to create a Cisco ATA binary configuration file (see the "Using Encryption With the cfgfmt Tool" section on page 3-12), automatically encrypts the binary file when the EncryptKey parameter has a value other than 0. The cfgfmt tool uses the rc4 encryption algorithm.
If this parameter value is set to 0, the Cisco ATA configuration file on the TFTP server is not encrypted.
Note
For examples on how to upgrade from the EncryptKey parameter to the stronger encryption method that uses the EncryptKeyEx parameter, see the "Examples of Upgrading to Stronger Encryption Key" section on page 3-15.
Value Type
Hexadecimal string
Range
Maximum number of characters: 8
Default
0
Voice Configuration Menu Access Code
320
Related Parameters
•
•
EncryptKeyEx
Description
This parameter specifies an encryption key that is stronger than the key specified with the EncryptKey parameter. This stronger key is used to encrypt the Cisco ATA configuration file on the TFTP server.
Note
When the EncryptKeyEx parameter is set to a non-zero value, the Cisco ATA uses this value as the encryption key and ignores any value that has been set for the EncryptKey parameter. The cfgfmt tool, which is used to create a Cisco ATA binary configuration file (see the "Using Encryption With the cfgfmt Tool" section on page 3-12), automatically encrypts the binary file using the stronger rc4 encryption algorithm.
When EncryptKeyEx is used for encryption, the Cisco ATA searches for the configuration file with the format ata<macaddress>.x. on the TFTP server.
If the value of the EncryptKeyEx parameter is 0, then the Cisco ATA uses the value of the EncryptKey parameter for encryption.
Note
For examples on how to upgrade from the EncryptKey parameter to the stronger encryption method that uses the EncryptKeyEx parameter, see the "Examples of Upgrading to Stronger Encryption Key" section on page 3-15.
Value Type
Hexadecimal string of the form:
Rc4PasswdInHex/macinHex_12
•
•
Range
Maximum number of characters: 64
Default
0
Voice Configuration Menu Access Code
Not applicable for this parameter.
Related Parameters
•
•
Network Configuration Parameters
This section includes the parameters for enabling or disabling the use of a DHCP server to obtain IP address information, and parameters that you need to statically configure if you disable DHCP:
•
•
•
•
•
•
DHCP
Description
A DHCP server can be used to automatically set the Cisco ATA IP address, the network route IP address, the subnet mask, DNS, NTP, TFTP, and other parameters.
•
•
Value Type
Boolean
Range
0 or 1
Default
1
Voice Configuration Menu Access Code
20
Related Parameters
•
•
StaticIp
Description
Use this parameter to statically assign the Cisco ATA IP address if the DHCP parameter is set to 0.
Value Type
IP address
Default
0.0.0.0
Voice Configuration Menu Access Code
1
Related Parameters
•
StaticRoute
Description
Use this parameter to statically assign the Cisco ATA route if the DHCP parameter is set to 0.
Value Type
IP address
Default
0.0.0.0
Voice Configuration Menu Access Code
2
Related Parameters
•
•
StaticNetMask
Description
Use this parameter to statically assign the Cisco ATA subnet mask if the DHCP parameter is set to 0
Value Type
IP address
Default
255.255.255.0
Voice Configuration Menu Access Code
10
Related Parameters
•
•
NTPIP
Description
This parameter is the NTP IP address, required if DHCP server does not provide one.
The Cisco ATA requires an NTP Server from which to obtain Coordinated Universal Time (UTC) to time-stamp incoming calls (H.323 and SIP) to drive an external Caller-ID device.
DHCP may also supply a NTP server. If NTPIP is specified, it overwrites the value supplied by DHCP. NTPIP is ignored if its value is 0 or 0.0.0.0.
The user must not specify a port parameter. The Cisco ATA uses the default NTP port only.
Value Type
IP address
Default
0.0.0.0
Voice Configuration Menu Access Code
141
Related Parameters
•
•
AltNTPIP
Description
This parameter is the alternate NTP IP address, if you want redundancy. You can set this parameter to 0 or point to the same NTPIP if only one NTP server exists.
Value Type
IP address
Default
0.0.0.0
Voice Configuration Menu Access Code
142
Related Parameters
•
•
DNS1IP
Description
This parameter is for setting the primary domain name server (DNS) IP address, if the DHCP server does not provide one. If DHCP provides DNS1IP (and if it is non-zero), this parameter overwrites the DHCP-supplied value. You cannot specify a port parameter. The Cisco ATA uses the default DNS port only.
Value Type
IP address
Default
0.0.0.0
Voice Configuration Menu Access Code
916
DNS2IP
Description
This parameter is for setting the secondary domain name server (DNS) IP address, if the DHCP server does not provide one. If DHCP provides DNS2IP (if it is non-zero), this parameter overwrites the DHCP-supplied value. You cannot specify a port parameter. The Cisco ATA uses the default DNS port only.
Value Type
IP address
Default
0.0.0.0
Voice Configuration Menu Access Code
917
VLANSetting
Description
This parameter is for firmware version 2.15 and above.
Bitmap definitions are as follows for the VLANSetting parameter:
•
•
•
•
•
Value Type
Bitmap
Default
0x0000002b
Voice Configuration Menu Access Code
324
Related Parameter
H.323 Parameters
This sections describes the following parameters, which include H.323 Gatekeeper configuration parameters:
•
•
•
•
•
•
•
•
•
GkOrProxy
Description
This parameter is the IP address of the primary H.323 gatekeeper.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0—Disables gatekeeper-routed calls.
Voice Configuration Menu Access Code
5
Related Parameters
•
•
GkId
Description
This parameter is the identifier for the primary H.323 gatekeeper.
Value Type
Alphanumeric string
Default
. (not specified)
Range
Maximum 31 characters
Voice Configuration Menu Access Code
91
GkTimeToLive
Description
This parameter specifies the "time to live" value that is used when the Cisco ATA registers with the H.323 gatekeeper. The registration is valid until the configured time expires.
Value Type
Integer
Default
0
Range
30 to 4294967295 seconds
Voice Configuration Menu Access Code
250
AltGk
Description
You have the option of using this parameter to statically specify the IP address of an alternate H.323 gatekeeper.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
6
Related Parameter
AltGkTimeOut
Description
You can use this parameter to specify the timeout in seconds before the Cisco ATA fails back to the primary gatekeeper from the backup gatekeeper. When the Cisco ATA switches to a different H.323 gatekeeper, the setting of Bit 3 of the ConnectMode parameter (see the "ConnectMode" section) determines whether the Cisco ATA re-registers with the H.323 gatekeeper.
Value Type
Integer
Default
0—The Cisco ATA continues to use the backup gatekeeper until it fails before attempting to fail back to the primary gatekeeper.
Range
30 to 4294967295 seconds
Voice Configuration Menu Access Code
251
Related Parameters
•
•
UID0
Description
This parameter is the User ID (E.164 phone number) for the Phone 1 port. If the value is set to zero, the port will be disabled and no dial tone will sound.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
3
Related Parameters
•
•
•
•
•
PWD0
Description
This parameter is the password for the Phone 1 port.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
4
Related Parameters
•
•
•
•
•
UID1
Description
This parameter is the User ID (E.164 phone number) for the Phone 2 port. If the value is set to zero, the port will be disabled and no dial tone will sound.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
13
Related Parameters
•
•
•
•
•
PWD1
Description
This parameter is the password for the Phone 2 port.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
14
Related Parameters
•
•
•
•
•
LoginID0
Description
This parameter is the H.323 login ID for the Phone 1 port of the Cisco ATA.
This value is used for registration and authentication if the UseLoginID parameter is set to 1.
If the LoginID0 and LoginID1 parameter values are identical, only one gatekeeper registration is performed for both ports, in which case the LoginID0 value is used as the H.323 ID, and the UID0 and UID1 parameter values are used for the two E.164 phone numbers.
Value Type
Alphanumeric string
Range
Maximum number of characters: 51
Default
0
Voice Configuration Menu Access Code
46
Related Parameters
•
•
•
LoginID1
Description
This parameter is the H.323 login ID for the Phone 2 port of the Cisco ATA.
This value is used for registration and authentication if the UseLoginID parameter is set to 1.
If the LoginID0 and LoginID1 parameter values are identical, only one gatekeeper registration is performed for both ports, in which case the LoginID0 value is used as the H.323 ID, and the UID0 and UID1 parameter values are used for the two E.164 phone numbers.
Value Type
Alphanumeric string
Range
Maximum number of characters: 51
Default
0
Voice Configuration Menu Access Code
47
Related Parameters
•
•
•
UseLoginID
Description
0—Use UID0 and UID1 as the authentication ID.
1—Use LoginID0 and LoginID1 as the authentication ID.
Value Type
Boolean
Range
0 or 1
Default
0
Voice Configuration Menu Access Code
93
AutMethod
Description
Use this parameter to select the desired authentication method, with the following possible values:
•
•
•
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
92
Related Parameters
•
•
•
•
•
•
Gateway
Description
Use this parameter to specify the H.323 gateway IP address if the network does not contain an H.323 gatekeeper. In this scenario, all calls originating from the Cisco ATA will be directed to the gateway specified in this parameter.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
11
Audio Configuration Parameters
This section describes the following audio parameters, which allow you to configure such items as codecs and silence suppression:
•
•
•
•
MediaPort
Description
Use this parameter to specify the base port where the Cisco ATA transmits and receives RTP media. This parameter must be an even number. Each connection uses the next available even-numbered port for RTP.
Value Type
Integer
Range
1 to 65535
Default
16384
Voice Configuration Menu Access Code
202
Related Parameters
•
RxCodec
Description
Use this parameter to specify receiving-audio codec preference. The following values are valid:
•
•
•
•
Value Type
Integer
Range
0-3
Default
2
Voice Configuration Menu Access Code
36
Related Parameters
•
•
TxCodec
Description
Use this parameter to specify the transmitting-audio codec preference. The following values are valid:
•
•
•
•
Value Type
Integer
Range
0-3
Default
2
Voice Configuration Menu Access Code
37
Related Parameters
•
•
LBRCodec
Description
This parameter allows you to specify which low-bit-rate codecs are available. The Cisco ATA is capable of supporting two G.723.1 connections or one G.729 connection. When G.723.1 is selected as the low-bit-rate codec, each FXS port is allocated with one G.723.1 connection. When G.729 is selected, only one FXS port is capable of operating with the G.729 codec. The allocation of the G.729 resource to the FXS port is dynamic. The G.729 resource, if available, is allocated to an FXS port when a call is initiated or received; the resource is released when a call is completed.
The following values are valid:
•
•
Value Type
Integer
Range
0 or 3
Default
0
Voice Configuration Menu Access Code
300
Related Parameters
•
•
•
AudioMode
Description
This parameter represents the audio operating mode. The lower 16 bits are for the Phone 1 port, and the upper 16 bits are for the Phone 2 port. Table 5-1 provides definitions for each bit.
Value Type
Bitmap
Default
0x00150015
Voice Configuration Menu Access Code
312
Related Parameters
•
•
NumTxFrames
Description
Use this parameter to select the number of frames per packet that the Cisco ATA transmits:
•
•
Note
Examples
•
•
Note
Value Type
Integer
Range
1-6
Default
2
Voice Configuration Menu Access Code
35
Related Parameters
•
•
•
TOS
Description
This parameter allows you to configure Type of Service (ToS) bits by specifying the precedence and delay of audio and signaling IP packets, as follows:
•
Range: 0-255
Default: 184
•
Range: 0-255
Default: 168
•
Value Type
Bitmap
Default
0x0000A8B8
Voice Configuration Menu Access Code
255
Note
Operational Parameters
This section describes the following parameters, which allow you to configure such items as call features and various timeout values:
•
•
•
•
CallFeatures
Description
Disable/enable CallFeatures by setting each corresponding bit to 0 or 1.
The lower 16 bits are for the Phone 1 port, and the upper 16 bits are for the Phone 2 port. Table 5-2 provides definitions of each bit.
Note
Value Type
Bitmap
Default
0xffffffff
Voice Configuration Menu Access Code
314
Related Parameters
•
PaidFeatures
Description
Unsubscribe/subscribe to CallFeatures by setting each corresponding bit to either 0 or 1. The lower 16 bits are for the Phone 1 port, and the upper 16 bits are for the Phone 2 port. Table 5-3 provides definitions of each bit.
Value Type
Bitmap
Default
0xffffffff
Voice Configuration Menu Access Code
315
Related Parameters
•
•
CallCmd
Description
Command table that controls call commands such as turning on/off caller ID.
For detailed information on the CallCmd parameter, see "Call Commands"
Value Type
Alphanumeric string
Range
Maximum of 248 characters
Default
U.S. Call Command Default
Af;AH;BS;NA;CS;NA;Df;EB;Ff;EP;Kf;EFh;HH;Jf;AFh;HQ;I*67;gA*82;fA#90v#;OI;H#72v#;bA#74v#;cA#75v#;dA#73;eA*67;gA*82;fA*70;iA*69;DA*99;xA;Uh;GQ;
Voice Configuration Menu Access Code
930
Related Parameters
•
FeatureTimer
Description
This parameter provides configurable timing values for various telephone features, as described below:
•
•
You can configure FeatureTimer parameter bits 16-18 to specify the ringing period for incoming call-waiting calls.
This feature can be disabled by either using the default value 0 or by setting bits 16-18 to a value greater than the standard timeout for an incoming call as specified in SigTimer parameter bits 14-19. When this feature is disabled, a "480 Temporarily Not Available" response is returned to the remote user agent when the standard ring times out.
–
–
–
–
•
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
317
FeatureTimer2
Description
This parameter provides configurable timing values for various Cisco ATA features, as described below:
•
–
–
–
–
Note
Value Type
Bitmap
Default
0x0000001e
Voice Configuration Menu Access Code
361
SigTimer
Description
This parameter controls various timeout values. Table 5-4 contains bit definitions of this parameter.
Value Type
Bitmap
Default
0x01418564
Voice Configuration Menu Access Code
318
ConnectMode
Description
This parameter is a 32-bit bitmap used to control the connection mode of the selected call signaling protocol. Table 5-5 provides bit definitions for this parameter.
Value Type
Bitmap
Default
0x00060400
Voice Configuration Menu Access Code
311
OpFlags
Description
This parameter enables/disables various operational features.
See Table 5-6 for bit definitions of this parameter.
Value Type
Bitmap
Default
0x2
Voice Configuration Menu Access Code
323
Related Parameters
•
•
Table 5-6 OpFlags Parameter Operational Features to Turn On or Off
0
If Bit 0 = 0, the TFTP configuration filename supplied by the DHCP server overwrites the default filename for each Cisco ATA.
If Bit 0 = 1, the default Cisco ATA filename is always used.
Default: 0
1
If Bit 1 = 0, the Cisco ATA probes the static network router during the power-up process.
If Bit 1 = 1, static network router probing is disabled.
Default: 1
2
Reserved.
3
If Bit 3=1, the Cisco ATA does not request DHCP option 150 in the DHCP discovery message; some DHCP server do not respond if option 150 is requested.
Default: 0
4
If Bit 4 = 1, the Cisco ATA use the VLAN ID specified in the VLANSetting parameter for VLAN IP encapsulation (see the "VLANSetting" section).
Default: 0
5
If Bit 5=1, the Cisco ATA does not use VLAN IP encapsulation.
Default: 0
6
If Bit 6=1, the Cisco ATA does not perform CDP discovery.
Default: 0
7
If Bit 7=1, the Cisco ATA does not allow web configuration. Once the web server is disabled, you must configure the Cisco ATA with the TFTP or voice configuration menu methods.
Examples
1.
If you later attempt to access the Cisco ATA web configuration page, the following error messages will be displayed.
–
–
2.
Default: 0
8
If Bit 8=1, the Cisco ATA does not allow HTTP refresh access with the http://ip/refresh command.
Default: 0
9
If Bit 9=1, the Cisco ATA does not allow HTTP reset access with the http://ip/reset command.
Default: 0
10
Reserved.
11
If Bit 11=0, the Cisco ATA requests the device hostname from the DHCP server.
If Bit 11=1, the Cisco ATA uses the device hostname that is specified in DHCP option 12.
Default: 0
12
Reserved.
13
DNS Servers For Name Resolution
If Bit 13=0 (default), use statically configured DNS IP addresses, if available, for name resolution. If statically configured DNS servers are not available, use DHCP-provided DNS IP addresses for name resolution.
If Bit 13=1, use both statically configured DNS IP addresses and as many as two DHCP-provided DNS IP addresses. Therefore, the Cisco ATA can query as many as four DNS IP addresses in one DNS query.
For more information about statically configured DNS IP addresses, see the "DNS1IP" section section and the "DNS2IP" section section.
Default: 0
14
DNS Servers For Name Resolution 2
If Bit 14=0 (default), use statically configured DNS IP addresses (DNS1IP and DNS2IP), if available, for name resolution; otherwise, use DHCP-provided DNS IP addresses.
If Bit 14=1, use both statically configured (DNS1IP and DNS2IP) and DHCP-provided DNS IP addresses (maximum of two) for name resolution.
Note
15
Disable UDP Checksum Generation
If Bit 13=0, generate UDP checksum in outgoing UDP packets.
If Bit 13=1, disable generation of of UDP checksum in outgoing UDP packets.
Default: 0
16-27
Reserved.
28-31
To configure the Cisco ATA to prompt the user for the UIPassword when the user attempts to perform a factory reset or upgrade using the voice configuration menu, configure bits 28 to 31 with the value of 6. Any other value for these bits means that the Cisco ATA will not prompt the user for the UIPassword in these cases.
TimeZone
Description
This parameter is the timezone offset (in hours) from Greenwich Mean Time (GMT) for time-stamping incoming calls with local time (to use for Caller ID display, for example). See the "Additional Description" heading later in the description of this parameter for selecting time offsets for timezones that have 30-minute-factor or 45-minute-factor offset from GMT.
Local time is generated by the following formula:
•
•
Value Type
Integer
Range
0-24
Default
17
Voice Configuration Menu Access Code
302
Additional Description
Use the following list to select Timezone offset (in minutes) from GMT for the following cities and countries that have 30-minute-factor and 45-minute-factor time zone offsets. These values are integers and can range from -720 through -60, and from 60 through 780.
•
•
•
•
•
•
•
Note
Related Parameters
•
•
Telephone Configuration Parameters
This section includes the following parameters, which allow you to configure items such as generating caller ID format and controlling line polarity:
•
CallerIdMethod
Description
This 32-bit parameter specifies the signal format to use for both FXS ports for generating Caller ID format. Possible values are:
•
If method=0 (default), set the following bits:
•
•
•
•
•
•
If method=1, set the following bits:
•
•
•
•
•
•
•
•
•
•
If method=2, set the following bits:
•
•
•
•
•
•
Examples
The following examples are recommended values for the CallerID Method parameter:
•
•
•
•
•
Value Type
Bitmap
Default
0x00019e60
Voice Configuration Menu Access Code
316
Polarity
Description
You can control line polarity of the Cisco ATA FXS ports when a call is connected or disconnected by configuring the Polarity bitmap parameter as follows:
•
–
–
•
–
–
•
–
–
•
–
–
Note
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
304
FXSInputLevel
Description
Use this parameter to specify the input level control (analog-to-digital path) of the Cisco ATA FXS ports.
Value Type
Integer
Range
-9 to 2 dB
Default
-1
Voice Configuration Menu Access Code
370
Related Parameter
FXSOutputLevel
Description
Use this parameter to specify the output level control (digital-to-analog path) of the Cisco ATA FXS ports.
Value Type
Integer
Range
-9 to 2 dB
Default
-4
Voice Configuration Menu Access Code
371
Related Parameter
Tone Configuration Parameters
The Cisco ATA supports the following tone parameters:
•
•
•
•
•
•
The Cisco ATA supports two types of tone-parameter syntax—basic format and extended format. Basic format is used in most countries; use the extended format only if the country in which the Cisco ATA is used requires this format.
This section covers all the call-progress tones that the Cisco ATA supports, and contains the following topics:
•
•
•
This section also covers the following parameter, which is for configuring phone-ringing characteristics:
Note
Tone Parameter Syntax—Basic Format
Each tone is specified by nine integers, as follows:
parametername: NumOfFreqs,Tfreq1,Tfreq2,Tamp1,Tamp2,Steady,OnTime,OffTime, TotalToneTime•
•
•
32767 * cos (2*pi*F/8000)
where F is the desired frequency in Hz. Set this value to 0 if the frequency does not exist.
The range of each value is -32768 to 32767.
For negative values, use the 16-bit 2's complement value. For example, enter -1 as 65535 or as 0xffff.
•
32767 * A * sin(2*pi*F/8000)
A (amplitude factor) = 0.5 * 10^((k+10-(n-1)*3)/20)
where F is the desired frequency in Hz, k is the desired volume in dBm, and n is the number of frequencies. The ^ symbol means to the order of.
•
•
Specify each value as a number of samples with a sampling rate of 8 kHz. The range of each value is 0 to 0xffff. For example, for a length of 0.3 seconds, set the value to 2400.
•
Specify each value as a number of samples with a sampling rate of 8 kHz. The range of each value is 0 to 0xffff. For example, for a length of 0.3 seconds, set the value to 2400.
•
For the remaining tones, the configurable value is the number of samples with a sampling rate of 8 kHz.
Note
Tone Parameter Syntax—Extended Formats
Two types of extended format exist for the Cisco ATA tone parameters:
•
–
–
–
–
–
•
Extended Format A
Each tone is specified by 11 integers, as follows:
parametername:NumOfFreqs,Tfreq1,Tamp1,Tfreq2,Tamp2,NumOfOnOffPairs,OnTime1,
OffTime1,OnTime2,OffTime2,TotalToneTime•
•
•
32767 * cos (2*pi*F/8000)
where F is the desired frequency in Hz. Set this value to 0 if the frequency does not exist.
The range of each value is -32768 to 32767.
For negative values, use the 16-bit 2's complement value. For example, enter -1 as 65535 or as 0xffff.
•
32767 * A * sin(2*pi*F/8000)
A (amplitude factor) = 0.5 * 10^((k+10-(n-1)*3)/20)
where F is the desired frequency in Hz, k is the desired volume in dBm, and n is the number of frequencies. The ^ symbol means to the order of.
•
Valid values are 0, 1 and 2. Use 0 if the tone is steady.
•
Specify each value as a number of samples with a sampling rate of 8 kHz. The range of each value is 0 to 0xffff. For example, for a length of 0.3 seconds, set the value to 2400.
•
Specify each value as a number of samples with a sampling rate of 8 kHz. The range of each value is 0 to 0xffff. For example, for a length of 0.3 seconds, set the value to 2400.
Figure 5-1 Cadence With Two On-Off Pairs
•
For the remaining tones, the configurable value is the number of samples with a sampling rate of 8 kHz.
Note
Extended Format B
The ReorderTone parameter specifies the tone that the Cisco ATA plays when the called number is not available or the external circuit is busy. This tones can consist of:
•
For example, a 400 Hz frequency plays four times for 0.75 second followed by 0.1 second of silence after each play and then plays one time for 0.75 second followed by 0.4 second of silence. This pattern can be set to repeat until another call event stops the pattern.
•
For example, the frequencies 900 Hz, 1400 Hz, and 1800 Hz play sequentially for 0.33 seconds each with no silence after the first and second frequencies but one second of silence after the third frequency.
The syntax of the ReorderTone parameter is specified by 17 integers, as follows:
ReorderTone:Sequential,NumOfFreqs,TFreq1,Tamp1,TFreq2,
Tamp2,TFreq3,Tamp3,NumOfOnOffPairs,OnTime1,OffTime1,
OnTime2,OffTime2,OnTime3,OffTime3,NumOfRepeats,TotalToneTimewhere:
•
•
•
32767 * cos (2 * pi * F/8000)
where F is the desired frequency in Hz. Set this value to 0 if the frequency does not exist.
The range of each value is -32768 to 32767.
For negative values, use the 16-bit 2's complement value. For example, enter -1 as 65535 or as 0xffff.
•
32767 * A * sin(2*pi*F/8000)
A (amplitude factor) = 0.5 * 10^((k+10-(n-1)*3)/20)
where F is the desired frequency in Hz, k is the desired volume in dBm, and n is the number of frequencies (If Sequential is set to 101, n is equal to 1). The ^ symbol means to the order of.
•
If this value is 0, the OnTime1, OnTime2, OnTime 3, OffTime1, OffTime2, and OffTime3 values must also be 0.
•
Specify each value as a number of samples with the sampling rate of 8 kHz. The range of each value is 0 to 0xffff.
For example, for a length of 0.3 seconds, set a value to 2400.
•
Specify each value as a number of samples with the sampling rate of 8 kHz. The range of each value is 0 to 0xffff.
For example, for a length of 0.3 seconds, set a value to 2400. (See Figure 5-2 for a graphical representation.)
Figure 5-2 Cadence with Three On-Off Pairs
•
For example, if NumOfRepeats is 2, the first on-off pair will play three times (it will play once and then repeat two times), then the second on-off pair will play.
•
This value is in 10 ms units (100 ms = 1 second).
Two examples of Extended Format B, both using the Reorder tone, follow.
ReorderTone Parameter Example1
Assume that you want a reorder tone in which:
•
•
•
•
•
•
For this reorder tone, make the following setting. See Table 5-7 for a detailed explanation.
ReorderTone:101,3,24917,3405,14876,4671,5126,5178,3,2640,0,2640,0,
2640,8000,0,0
ReorderTone Parameter Example 2
Assume that you want a reorder tone in which:
•
•
•
•
•
For this reorder tone, make the following setting. See Table 5-8 for a detailed explanation.
ReorderTone:100,1,31164,1620,0,0,0,0,2,800,7200,2400,5600, 0,0,5,0
Recommended Values
The following settings are recommended for the US:
•
•
•
•
•
•
Note
Specific Tone Parameter Information
Brief descriptions, and lists of default values and the voice configuration menu code for each Cisco ATA tone parameter, appear in the following sections:
•
•
DialTone
Description
The Cisco ATA plays the dial tone when it is ready to accept the first digit of a remote address to make an outgoing call.
Default values (using the Basic format)
•
•
•
•
•
•
•
•
•
Voice Configuration Menu Access Code
920
BusyTone
Description
The Cisco ATA plays the busy tone when the callee is busy.
Default values (using the Basic format)
•
•
•
•
•
•
•
•
•
Voice Configuration Menu Access Code
921
ReorderTone
Description
The Cisco ATA plays the reorder tone (also known as congestion tone) if the outgoing call failed for reasons other than busy. This is a fast-busy tone.
Default values (using the Basic format)
•
•
•
•
•
•
•
•
•
Voice Configuration Menu Access Code
922
RingbackTone
Description
The Cisco ATA plays the ring-back tone when the callee is being alerted by the called device.
Default values (using the Basic format)
•
•
•
•
•
•
•
•
•
Voice Configuration Menu Access Code
923
CallWaitTone
Description
The Cisco ATA plays the call-waiting tone when an incoming call arrives while the user is connected to another party.
Default values (using the Basic format)
•
•
•
•
•
•
•
•
•
Voice Configuration Menu Access Code
924
AlertTone
Description
The Cisco ATA plays the alert tone as a confirmation tone that a special event, such as call forwarding, is in effect.
Default values (using the Basic format)
•
•
•
•
•
•
•
•
•
Voice Configuration Menu Access Code
925
RingOnOffTime
Description
This parameter specifies the ringer cadence pattern, expressed as a triplet of integers "a,b, and c".
•
•
•
Value Type
List of three integer values, separated by commas
Range
1-65535
Default
2, 4, 25
Recommended Values:
•
•
Voice Configuration Menu Access Code
929
Dial Plan Parameters
This section describes the configurable parameters related to dial plans:
•
DialPlan
Description
The programmable dial plan is designed for the service provider to customize the behavior of the Cisco ATA for collecting and sending dialed digits. The dial plan allows the Cisco ATA user to specify the events that trigger the sending of dialed digits. These events include the following:
•
•
•
•
Value Type
Alphanumeric string
Range
Maximum number of characters is 199.
Note
Default
*St4-|#St4-|911|1>#t8.r9t2-|0>#t811.rat4-|^1t4>#.-
Voice Configuration Menu Access Code
926
Additional DialPlan Information
The DialPlan section contains the following additional topics that describe commands and rules for creating your own dial plan, and includes many examples:
Dial Plan Commands
The following list contains commands that can be used to create you own dial plans:
•
•
•
•
For example, a dial plan rule of (1900|1800|17..)555.r3 or three dial plan rules of 1900555.r3|1800555.r3|17..555.r3 are equivalent. A match is reached if 11 digits are entered and the first three digits are either 1900, 1800, or 17..., and the fifth, sixth, and seventh digits are all 5.
•
•
•
Note
•
•
•
Note
Note
Dial Plan Rules
The Cisco ATA supports the following dial plan rules:
•
•
•
•
•
•
•
(In Rule) for Dial Plan Blocking
Dial plan blocking can be used to reduce the occurrences of invalid dialed digits being sent and can prevent the dialed string of a specified pattern from being sent. By adding dial plan blocking, dialed digits are discarded after the interdigit timer expires unless one of the specified matching rules is met.
In addition, the default nine-second global interdigit timeout value is also modified with the value specified in the dial plan blocking command:
Syntax
Inwhere n specifies the global interdigit timeout and the valid values are 1-9 and a-z (10-35).
Example
Ic| 911This command specifies an interdigit timeout of 12 seconds, and will discard dialed digits unless 911 is entered.
Specifying your own interdigit timeout also changes the behavior of the dial plan so that the entire dial string, rather than being sent at timeout, is sent only as a result of a matching rule or time intended by a matching rule.
`H' Rule to Support Hot/Warm Line
Hotline/Warmline, also known as Private Line Automatic Ringdown (PLAR), is a line used for priority telephone service. If the Hotline feature is configured, the Cisco ATA immediately dials a pre-configured number as soon as the handset goes off hook. If the Warmline feature is configured, the Cisco ATA dials a pre-configured number if no digits were entered before the specified timer value expired when the handset went offhook.
Syntax
Hdnnnnwhere d is a delay-in-seconds parameter 0-9,a-z (to support 0 to 35 seconds delay), and nnnn is the variable-length phone number to call when no digits are entered for d seconds after offhook.
Example 1
H05551212This is a hotline configuration; the Cisco ATA immediately dials 555-1212 when the handset goes off hook.
Example 2
H55551212This is a warmline configuration; the Cisco ATA waits for five seconds and dials 555-1212 if no digits were entered when the handset went off hook.
`P' Rule to Support Dial Prefix
This rule is for automatic pre-pending the dial string as entered by the user with a specified prefix.
Syntax
Ptnnnnwhere t is a single leading trigger character; if t is the first entered digit when making a new call, it triggers the prepending of a variable-length prefix (as specified by nnnn) in the dial string. The t character can take one of the following values:
0-9,*,#, 'n' (= any of 1-9), 'N' (any of 'n' and 0), 'a' (any of 'n',* and #), or 'A' (any of 'a' and 0);
Example
Pn12345This rule prepends 12345 to the dial string when the first entered digit is any of 1-9. The triggered digit is not removed from the dial string.
`R' Rule for Enhanced Prefix
This enhanced prefix rule matches entire strings, whereas the `P' rules matches only a single digit. The `R' rule is for automaticly prepending a specified prefix to the dialed string. The string must be an exact match to trigger the rule. If more than one `R' rule matches, the first matched `R' rule is triggered.
The `R' rule also uses negation to exclude one or more leading digits before prepending the defined prefix string.
The number of dashes (-) after the R represents the number of leading digits that will be removed preceding the prefix.
Syntax
Rnnnn(tttt)where tttt is a trigger string. If the dialed numbers match this string, this match triggers the prepending of a variable-length prefix (as specified by nnnn) to the dial string. The triggered string is not removed from the dial string. The negation, subrule matching and range patterns can be applied to the trigger strings.
Example 1
R1212([2_9]-)This rule prepends 1212 to dial strings that have a leading digit of 2 to 9.
Note
Example 2
R-0033(0[1-9].r7)This removes the first dialed digit, then prepends 0033 to the dialed string. For example, if the number 0148336134 is dialed, the resulting string becomes 0033148336134.
Example 3
R----0(0033[1-9].r7)This removes the first four dialed digits, then prepends 0 to the dialed string. For example, if the number 0033148336134 is dialed, the resulting string becomes 0148336134.
Log Information
The Call Prefix <prefix>+<num> is shown in the prserv log.
`C' Rule for Call Blocking
This rule is for blocking call numbers.
Syntax
Cnnnnwhere nnnn is the leading set of digits of the blocked call number; nnnn can be composed with subrule matching and range. The rule is triggered when the leading digits of a dialed string match the string nnnn.
The `C' rule does not work with negation.
Example:
C1900|C1888 or C(1900|1888)This rule blocks call numbers beginning with 1900 or 1888.
Log Information
The Call Block <num> is shown in the prserv log, and a busy tone is being played.
`F' Rule for Call Forwarding Blocking
This rule is for blocking call forwarding numbers.
Syntax
Fnnnnwhere nnnn is the leading set of digits of the blocked call forwarding number; nnnn can be composed with subrule matching and range. The rule is triggered when the leading digits of a dialed forwarding number match the string nnnn. The `F' rule does not work with negation.
Example:
F1900|F1888 or F(1900|1888)These rules block call forwarding numbers beginning with 1900 or 1888.
Log Information
The CFWD Block:<num> is shown in the prserv log, and a busy tone is being played.
`X' Rule for Call Blocking and Call Forwarding Blocking
This rule is for blocking call numbers and call forwarding numbers.
Syntax
Xnnnnwhere nnnn is the leading set of digits of the blocked call number and blocked call forwarding number; nnnn can be composed with subrule matching and range. The rule is triggered when the leading set of digits of a dialed call number or forwarding number match the string nnnn. The `F' rule does not work with negation.
Example
X1900|X1888 or X(1900|1888)This rule blocks the call numbers and call forwarding numbers beginning with 1900 or 1888.
`D' Rule for Displaying Caller ID
This rule is for displaying caller ID at the remote site. The number must be an exact match to trigger the rule.
Syntax
Dnnnn
where nnnn is the callee number. The caller ID will show to the callee; nnnn automatically becomes a valid calling number. Also, nnnn can be composed with negation, subrule matching and range. The `D' rule is checked before the `R' and `P' rules.
Example
D911This rule shows the caller ID at the remote side when if the call number is 911.
Log Information
SCC Cmd[]:CLIP or CLIP:<num> are shown in the prserv log.
Dial Plan Examples
This section contains three dial plan examples that use many different rules and commands.
Dial Plan Example 1 (Default Dial Plan)
The following dial plan:
*St4-|#St4-|911|1>#t8.r9t2-|0>#t811.rat4-|^1t4>#.-consists of the following rules:
•
•
•
•
•
•
Dial Plan Example 2
The following dial plans:
.t7>#......t4-|911|1t7>#..........t1-|0t4>#.t7-or.t7>#r6t4-|911|1t7>#.r9t1-|0t4>#.t7-consist of the following rules:
•
•
•
•
Dial Plan Example 3
The following dial plan:
R1408([2_9].r5|[2_9].r6)|R9^(911|.r4)|X(1900|1888)|F011consists of the following rules:
•
•
•
•
In Dial Plan Example 3, there are two `R' rules, so the first matched rule is triggered. Therefore, 5551234 becomes 14085551234. However, 555123 will then become 9555123 because it matches the second rule.
DialPlanEx
If your dial plan exceeds 199 characters, then use must use the DialPlanEx parameter to configure your dial plans. The DialPlanEx parameter supports dial plans up to 499 characters in length. This range in the number of characters is the only difference between the DialPlanEx and DialPlan parameters. Therefore, all the information about the DialPlan parameter applies to the DialPlanEx parameter. For more information, see the "DialPlan" section.
Note
IPDialPlan
Description
This Iparameter allows for detection of IP-like destination address in DialPlan. Three values are valid:
•
•
•
All other values are currently undefined.
Value Type
Integer
Range
0, 1 or 2
Default
1
Voice Configuration Menu Access Code
310
Diagnostic Parameters
This section describes the following parameters, which are used for diagnostic purposes:
•
•
NPrintf
Description
Use this parameter to specify the IP address and port of a host to which all Cisco ATA debug messages are sent. The program prserv.exe, which comes bundled with the Cisco ATA software, is needed to capture the debug information.
Syntax
<HOST_IP>,<HOST_PORT>
Example
If the program prserv.exe is running on a host with IP address 192.168.2.170 and listening port 9001, set NPrintf to 192.168.2.170.9001. This causes the Cisco ATA to send all debug traces to that IP address.
Value Type
Extended IP address
Default
0
Voice Configuration Menu Access Code
81
SyslogIP
Description
Use this parameter for diagnostic purposes; specify the IP address and port number to which the Cisco ATA should send its syslog output information.
The program prserv.exe, which is included in all Cisco ATA software upgrade packages, can be used to capture syslog information if you do not have a syslog server.
Syntax
<HOST_IPaddress>.<HOST_PORT>
Example
If you want to send syslog information to the host at IP address 192.168.2.170 and port number 514, do the following:
•
•
prserv 514Value Type
Extended IP address
Default
0.0.0.0.514
Voice Configuration Menu Access Code
7975640
Related Parameter
SyslogCtrl
Description
Use this parameter to turn on specific syslog traces. All traces are sent to the syslog server specified in the SyslogIP parameter.
See Table 5-9 for bit values and the corresponding types of messages to turn on for tracing.
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
7975641
Related Parameter
CFGID—Version Parameter for Cisco ATA Configuration File
Description
CFGID is a 32-bit unsigned-value parameter whose purpose is to allow the local administrator to track the version of the Cisco ATA configuration file. This parameter-value assignment is entirely the responsibility of the local administrator, and has no significance to the operation of the Cisco ATA.
Value Type
Bitmap
Default
0x00000000
Posted: Fri Apr 2 12:56:17 PST 2004
All contents are Copyright © 1992--2004 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.
