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. The parameter sections are grouped according to the color coding that appears on the Cisco ATA Web configuration screen.
The Cisco ATA uses the following parameter types:
Alphanumeric string
Array of short integers
Boolean (1 or 0)
Bitmap value—unsigned hexadecimal integer (for specifying bits in 32-bit integer)
Extended IP address—IP address with Port (for example, 192.168.2.170.9001)
Note The term Cisco ATA is used throughout this manual to refer to both the Cisco ATA 186 and the
Cisco ATA 188, unless differences between the Cisco ATA 186 and Cisco ATA 188 are explicitly stated.
Note This section contains recommended values for the United States and Sweden as configuration examples
for certain parameters. For information about other countries, contact the Cisco equipment provider for
a specific country.
Configuration Text File Template
This is a listing of the sk_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.
The sk_example.txt file contains all the Cisco ATA default values. A configuration file must begin with #txt so that the formatting tool, cfgfmt.exe, treats the file as a text file. The sections that follow this listing describe all the parameters in this file.
This parameter type contains one parameter—UIPassword—and is located in the purple portion of the Cisco ATA web configuration page.
UIPassword
Description
This parameter controls access to web page or voice configuration menu interface. To set a password, enter a value other than 0.
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). If you forget a password, you can contact your Cisco representative.
Note When UIPassword contains letters, you cannot enter the password from the telephone keypad.
Value Type
Alphanumeric string
Range
Maximum nine characters
Default
0
Voice Configuration Menu Access Code
7387277
Configuration Parameter
The one parameter in this section—ToConfig—is located in the light-yellow portion of the Cisco ATA web configuration page.
ToConfig
Description
After you configure the Cisco ATA, set the parameter to 0, or the Cisco ATA will unnecessarily contact the TFTP server.
Value Type
Boolean
Range
0 or 1
Default
1—This indicates that the operating parameters have not previously been set.
Voice Configuration Menu Access Code
80001
Parameters for Configuration Method and Encryption
This section describes parameters for instructing the Cisco ATA how to locate its TFTP server and how to encrypt its configuration file. These parameters are located in the grey portion of the Cisco ATA web configuration page:
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
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 on the TFTP server from which the Cisco ATA will download its configuration file.
For example, if the TFTP server IP address is 192.168.2.170 or www.cisco.com, and the path prefix for the configuration file on the TFTP server is in /ata186, you can specify the URL as 192.168.2.170/ata186 or www.cisco.com/ata186.
Note From the voice configuration menu, you can only enter the IP address; from the Web configuration page,
you can enter the actual URL.
Value Type
Alphanumeric string
Range
Maximum 31 characters
Default
0
Voice Configuration Menu Access Code
905
CfgInterval
Description
Use this parameter to specify the number of seconds between each configuration update. The Cisco ATA will also upgrade its signaling image it it detects that the TFTP server contains an upgraded image.
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
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 the EncryptKey Parameter and cfgfmt Tool" section), automatically encrypts the binary file, using the rc4 encryption algorithm, when the EncryptKey parameter has a value other than 0.
Note If the Cisco ATA configuration file is not encrypted, the value must be set to 0.
Value Type
Alphanumeric string
Range
Maximum eight characters
Default
0
Voice Configuration Menu Access Code
320
Network Parameters
This section describes the parameter 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. These parameters are located in the orange portion of the Cisco ATA Web Configuration Page:
This parameter can be used to automatically set the IP address of the Cisco ATA, the network route IP address, the subnet mask, DNS, NTP, TFTP, and other parameters.
1—Enable DHCP
0—Disable DHCP
Value Type
Boolean
Range
0 or 1
Default
1
Voice Configuration Menu Access Code
20
StaticIp
Description
Configure the Cisco ATA IP address using this parameter if the DHCP parameter is set to 0.
Value Type
IP address
Default
0.0.0.0
Voice Configuration Menu Access Code
1
StaticRoute
Description
Configure the Cisco ATA statically assigned route in this parameter if the DHCP parameter is set to 0.
Value Type
IP address
Default
0.0.0.0
Voice Configuration Menu Access Code
2
StaticNetMask
Description
Configure the statically assigned subnet mask using this parameter if the DHCP parameter is set to 0.
Value Type
IP address
Default
255.255.255.0
Voice Configuration Menu Access Code
10
Account Information Parameters
This section describes the following identification parameters, which are located in the blue portion of the Cisco ATA Web Configuration Page:
EPIDx (for MGCP only)specifies the alphanumeric Endpoint Identifier assigned to line x of the Cisco ATA, where x=0 or 1. The complete Endpoint Identifier sent to the Call Agent has the format <EPIDx>@<ip_addr>. (SIDx does not apply to MGCP.) To enable the usage of square brackets around the IP address of the endpoint, enable Bit 20 of the ConnectMode parameter. (See the "ConnectMode" section.)
Note Setting the EPID0orSID0 or EPID1orSID1 parameter to 0 does not disable the respective line.
Value Types
Alphanumeric string for each parameter
Default
.—The dot is the default and means that the value of aaln/1 is used as the MGCP endpoint ID for EPID1 and aaln/2 is used as the MGCP endpoint name for EPID2.
Range
Maximum 51 characters for each parameter
Voice Configuration Menu Access Codes
46 and 47 for EPID0orSID0 and EPID1orSID1, respectively
CA0orCM0
Description
Specify the primary Call Agent in this parameter. This parameter must be an IP address or URL and may include a port parameter. The default port number is 2727.
If you specify a port, you must separate the port number from the host IP address with a colon (:).
Examples
Examples of CA0orCM0 values follow:
192.168.1.2:2727
ca.cisco.com.
Value Type
Alphanumeric string
Range
Maximum 31 characters
Default
0
Voice Configuration Menu Access Code
5
CA1orCM1
Description
Specify the alternate Call Agent in this parameter. This parameter must be an IP address or URL and may include a port parameter. The default port number is 2727.
If you specify a port, you must separate the port number from the host IP address with a colon (:).
Note If no alternate Call Agent exists, this parameter value must be 0.
Examples
Examples of CA1orCM1 values follow:
192.168.1.2:2727
ca.cisco.com.
Value Type
Alphanumeric string
Range
Maximum 31 characters
Default
0
Voice Configuration Menu Access Code
6
MGCP-Specific Parameters
This section describes the following MGCP-specific parameters, which are located in the yellow portion of the Cisco ATA Web Configuration Page:
Set this parameter to 1 to enable using the MGCP signaling protocol.
Value Type
Boolean
Range
0 or 1
Default
0
Voice Configuration Menu Access Code
38
CA0UID
Description
Specify the ID of the primary Call Agent in this parameter.
Value Type
Alphanumeric string
Range
Maximum 31 characters
CA1UID
Description
Specify the ID of the secondary Call Agent in this parameter.
Value Type
Alphanumeric string
Range
Maximum 31 characters
MGCPVer
Description
Enter the MGCP version string that the Cisco ATA should use when it powers on. The following values are valid:
MGCP0.1
MGCP1.0
NCS1.0
Note Spaces are not permitted in the MGCPVer parameter.
Value Type
Alphanumeric
Default
MGCP1.0
Voice Configuration Menu Access Code
206
RetxIntv
Description
This parameter specifies the first retransmission interval of MGCP commands (in milliseconds). Subsequent retransmission periods double the previous interval (exponential backoff).
Value Type
Integer
Default
500
Voice Configuration Menu Access Code
203
RetxLim
Description
This parameter specifies the maximum number of times the Cisco ATA retransmits commands. When this value is exceeded, the Cisco ATA terminates its connection to the Call Agent and restarts.
Value Type
Integer
Default
10
Voice Configuration Menu Access Code
205
MGCPPort
Description
This parameter specifies the listening port for Media Gateway Control (MGCP) messages on the Cisco ATA. The Cisco ATA also sends MGCP messages from this port. Using the same port for sending and receiving messages may facilitate passage through Network Address Translation (NAT).
Value Type
Integer
Default
2427
Voice Configuration Menu Access Code
201
CodecName
Description
This parameter specifies the names of the encoder/decoders to use in the LocalConnectionOption parameter. You must list the names in the following order:
G.711µ-law
G.711A-law
G.723.1
G.729
Note All codec names must be separated by commas with no white space in between. If a name is empty, the
default standard-based name is used.
Value Type
Alphanumeric string
Range
The following list shows the maximum number of characters allowed for the respective codec names:
PCMU—six characters
PCMA—six characters
G.723—10 characters
G.729—eight characters
If a codec name is longer than the maximum, the default standard-based name is used.
Default Names
PCMU for G.711µ-law
PCMA for G.711A-law
G723 for G.723.1
G729 for G.729
Voice Configuration Menu Access Code
Not applicable
Operating Parameters
The parameters described in this section include parameters for configuring codecs, fax features and VLAN settings. The parameters described in this section are located in the green portion of the Cisco ATA Web Configuration Page:
This parameter is used for selecting the low-bit-rate codec. The following values are valid:
0—Select G.723.1 as the low-bit-rate codec (available only for connections 0 and 2).
3—Select G.729A as the low-bit-rate codec (available only for connection 0).
If LBRCodec=0, then both Cisco ATA FXS ports can operate with the following codecs:
Number of codecs=3
Codec[0]=G.711µ -law
Codec[1]=G.711A-law
Codec[2]=G.723.1
If LBRCodec=3, check the setting of bit 21 in the ConnectMode parameter (see the "ConnectMode" section) to determine if G.729 is enabled for the Phone 1 or Phone 2 FXS port.
If LBRCodec=3, then the Phone 1 FXS port can operate with the following codecs:
Number of codecs=4
Codec[0]=G.711µ-law
Codec[1]=G.711A-law
Codec[2]=G.729 (only if Bit 21 of the ConnectMode parameter is set to 0)
Codec[3]=G.729A
If LBRCodec=3, then the Phone 2 FXS port can operate with the following codecs:
Number of codecs=3
Codec[0]=G.711µ-law
Codec[1]=G.711A-law
Codec[2]=G.729 (only if Bit 21 of the ConnectMode parameter is set to 1)
Value Type
Integer
Range
0 or 3
Default
3
Voice Configuration Menu Access Code
300
PrfCodec
Description
This parameter specifies the default preferred codec. The following values are valid:
0=G.723.1 (only if LBRCodec=0)
1=G.711A-law
2=G.711u-law
3=G.729a (only if LBRCodec=3)
Value Type
Integer
Range
0 to 3
Default
1
Voice Configuration Menu Access Code
36
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
0x00350035
Voice Configuration Menu Access Code
312
Table 5-1 AudioMode Parameter Bit Definitions
Bit Number
Definition
0
0/1—Disable/enable G.711 silence suppression.
1
0—Enable selected low-bit-rate codec in addition to G.711. This setting is the default.
1—Enable G.711 only.
2
0/1—Disable/enable fax CED tone detection.
3
0/1—Disable/enable fax CNG tone detection.
4-5:DtmfMethod
0—Always in band.
1—Send AVT tone if remote SDP supports it; else send DTMF in-band.
2—Always send AVT tone.
3—Neither in-band DTMF nor AVT tone.
6-15
Reserved.
ConnectMode
Description
This parameter is a 32-bit bitmap to control the connection mode of the selected call signaling protocol. Table 5-2 provides bit definitions for this parameter.
Value Type
Bitmap
Default
0x90000400
Voice Configuration Menu Access Code
311
Table 5-2 ConnectMode Parameter Bit Definitions
Bit Number
Definition
0-1
Reserved.
2
0—Use the dynamic payload type 126/127 as the RTP payload type (fax pass-through mode) for G.711 µ-law/G.711 A-law.
1—Use the standard payload type 0/8 as the RTP payload type (fax pass-through mode) for G.711 µ-law/G.711 A-law.
3-6
Reserved.
7
0/1—Disable/enable fax pass-through redundancy.
8-12
Specifiy the fax pass-through NSE payload type with these bits. The value is the offset to the NSE payload base number of 96. The valid range is 0-23; the default is 4.
For example, if the offset is 4, the NSE payload type is 100.
0/1—Enable/disable persistent on-hook and off-hook events.
19
0/1—Enable/disable persistent hook-flash events.
20
0/1—Disable/enable using a pair of brackets to enclose the IP address of an endpoint identifier. For more information, see the "Endpoints and Connections" section.
This 32-bit parameter specifies the signal format to use for both FXS lines for generating Caller ID format. The following values are allowed:
Bits 0-1 (method)—0=Bellcore (FSK), 1=DTMF, values 2 and 3 are reserved.
If method=0, set the following bits:
Bit 3 to 8—Maximum number of digits in phone number part (valid values are 1 to 20)
Bit 9 to 14—Maximum number of digits in name number part (valid values are 1 to 20)
Bit 15—Use special character O.
Bit 16—Use special character P.
If method=1, set the following bits:
Bits 3-6—Start digit (valid values are 12 for "A," 13 for "B," 14 for "C," and 15 for "D.")
Bits 7-10—End digit (valid values are 11 for "#," 12 for "A," 13 for "B," 14 for "C," and 15 for "D.")
Bits 11—Polarity reversal before and after Caller ID signal (value of 0/1 disables/enables polarity reversal)
Bits 12-16—Maximum number of digits in phone number (valid values are 1 to 20)
Examples
The following examples are recommended values for the CallerID Method parameter:
Sweden=0x0ff61
Denmark=0x0fde1
USA=0x19e60
Value Type
Bitmap
Default
0x00019e60
Voice Configuration Menu Access Code
316
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, 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
Domain
Description
The Cisco ATA uses this parameter to determine how the domain-name portion of the endpoint identifier is constructed. The following values are valid:
Dot (.) or blank—Uses DHCP-provided IP address if available; otherwise use static IP address.
0—Uses DHCP-provided domain name if available; otherwise use static IP address.
*—Uses Cisco ATA MAC address.
String—Uses specified string.
Value Type
Alphanumeric string
Range
Maximum 31 characters
Default
.
Voice Configuration Menu Access Code
931
NumTxFrames
Description
Use this parameter to select the default RTP packet size in number of frames per packet. The Cisco ATA default frame sizes are as follows:
G.711 and G.729—10 ms
G.723.1—30 ms
For example, to receive 20 ms of G.729 packets, set the parameter to 2.
Value Type
Integer
Range
1-6
Default
2
Voice Configuration Menu Access Code
35
UDPTOS
Description
Use this parameter to specify the IP precedence (Tos bit )of UDP packets. Set the lower eight bits only, as follows:
Bits 0-1: Unused
Bit 2: Reliability bit—1=request high reliability
Bit 3: Throughput bit—1=request high throughput
Bit 4: Delay bit—1=request low delay
Bits 5-7: Specify datagram precedence. Values range from 0 (normal precedence) to 7 (network control).
Value Type
Bitmap
Default
0xB8
Voice Configuration Menu Access Code
255
OpFlags
Description
Enables/disables various operational features.
See Table 5-3 for bit definitions of this parameter.
Value Type
Bitmap
Default
0x2
Voice Configuration Menu Access Code
323
Table 5-3 OpFlags Parameter Operational Features to Turn On or Off
Bit Number
Definition
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.
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.
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.
4
If Bit 4 = 1, the Cisco ATA uses the VLAN ID specified in the VLANSetting parameter for VLAN IP encapsulation (see the "VLAN Setting" section).
5
If Bit 5=1, the Cisco ATA does not use VLAN IP encapsulation.
6
If Bit 6=1, the Cisco ATA does not perform CDP discovery.
7
If Bit 7=1, the Cisco ATA does not allow web-based configuration.
8
If Bit 8=1, the Cisco ATA does not allow HTTP refresh access with the http://ip/refresh command.
9
If Bit 9=1, the Cisco ATA does not allow HTTP reset access with the http://ip/reset command.
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.
12-31
Reserved.
VLAN Setting
Description
This parameter is for software versions 2.14.ms, 2.15.ms, and later.
Bitmap definitions are as follows for the VLAN Setting parameter:
Bits 0-2—Specify VLAN CoS bit value (802.1P priority) for TCP packets.
Bits 3-5—Specify VLAN CoS bit value (802.1P priority) for UDP packets.
Bits 6-17—Reserved.
Bits 18-29—User-specified 802.1Q VLAN ID.
Bits 30-31—Reserved.
Value Type
Bitmap
Default
0x0000002b
Voice Configuration Menu Access Code
324
Optional Feature Parameters
This section includes the parameters used to configure various timeout values and call-progress tones. The parameters in this section are located in the wheat-colored portion of the Cisco ATA Web Configuration Page:
ntone is the number of frequency components (0, 1 or 2).
freq[0] (Hz) is the transformed frequency of the first frequency component (-32768 to 32767).
Note Only positive values can be configured to the Cisco ATA 186. For negative values, use the 16-bit
2's-complement value. For example, enter -1 as 65535 or 0xffff.
freq[1]is the transformed frequency of the second frequency component (-32768 to 32767).
level[0] is the transformed amplitude of the first frequency component (-32768 to 32767).
level[1] is the transformed amplitude of the second frequency component (-32768 to 32767).
steady controls whether the tone is constant or intermittent. A value of 1 indicates a steady tone and causes the Cisco ATA to ignore the on-time and off-time parameters. A value of 0 indicates an on/off tone pattern and causes the Cisco ATA to use the on-time and off-time parameters.
on-timecontrols the length of time the tone is heard in milliseconds (ms) expressed as an integer from 0 to 0xffff sample at 8000 samples/second.
off-time controls the length of time between audible tones in milliseconds (ms) expressed as an integer from 0 to 0xffff sample at 8000 samples/second.
total-tone-time controls the length of time the tone is audible (0 to 0xffff). If this value is set to 0, the tone will play until another call event stops the tone. For DialTone, BusyTone, ReorderTone, and RingBackTone, the configurable value is the number of 10 ms (100 = 1 second) units.
For the other tones, the value is the number of samples at 8000 samples/second, where the following information applies:
Frequency ranges from 0 to 4000 (Hz)
Transformed Frequency = 32767 · cos (2pi·Frequency/8000)
Amplitude ranges from 0 to 32767
Transformed Amplitude = A · 32767 · sin (2pi·Frequency/8000)
Note All tones are persistent (until the Cisco ATA changes state) except for the call-waiting tone and the
confirm tone. The call-waiting tone, however, repeats automatically once every 10 seconds while the
call-waiting condition exists.
How to Calculate Scaling Factors
Use the following formula to calculate the scaling factor A:
A=0.5 * 10^((k+10-(n-1)*3)/20)
In this formula, k is the desirable volume in dBm; n is the number of frequency components. The ^ symbol means to the order of.
Example
If a one-frequency component of -20 dBm volume level is desirable, then:
A=0.5 * 10^((-20+10)/20) = 0.16
Recommended Values
The following settings are recommended for the US:
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 for the nine-integer array
ntone—2
freq0—31538
freq1—30831
level0—1380
level1—1740
steady—1
on-time—0
off-time—0
total time to play tone—1000
Voice Configuration Menu Access Code
920
BusyTone
Description
The Cisco ATA plays the busy tone when the callee is busy.
Default values for the nine-integer array
ntone—2
freq0—30467
freq1—28959
level0—1191
level1—1513
steady—0
on-time—4000
off-time—4000
total time to play tone—0
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.
Default values for the nine-integer array
ntone—2
freq0—30467
freq1—28959
level0—1191
level1—1513
steady—0
on-time—2000
off-time—2000
total time to play tone—0
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 for the nine-integer array
ntone—2
freq0—30831
freq1—30467
level0—1943
level1—2111
steady—0
on-time—16000
off-time—32000
total time to play tone—0
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 for the nine-integer array
ntone—1
freq0—30831
freq1—0
level0—5493
level1—0
steady—0
on-time—2400
off-time—2400
total time to play tone—4800
Voice Configuration Menu Access Code
924
ConfirmTone
Description
The Cisco ATA plays the confirm tone to prompt the user to enter a phone number when invoking a supplementary service, such as call-forwarding, or blind transfer.
Default values for the nine-integer array
ntone—1
freq0—30467
freq1—0
level0—5970
level1—0
steady—0
on-time—480
off-time—480
total time to play tone—1920
Voice Configuration Menu Access Code
925
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
TraceFlags
Description
This parameter is reserved in MGCP. The Cisco ATA will output all MGCP messages regardless of this parameter value.
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
313
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.
