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.
Some parameters on the Web Configuration screen are not used for SCCP; only those used for SCCP are covered in this section.
Parameters are divided into categories based on their functionality. The following categories of parameters are covered in this section:
The following list contains general configuration information:
Your configuration file must begin with #txt.
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 a 32-bit integer)
Extended IP address—IP address followed by port number (for example, 192.168.2.170.9001)
IP address (e.g. 192.168.2.170)
Integer (32-bit integer)
Numeric digit string
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.
This parameter type contains 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 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.
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:
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 From the voice configuration menu, you can only enter the IP address; from the web configuration page,
you can enter the actual URL.
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.
This section describes 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:
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.
SIDx specifies whether to enable the Phone 1 and/or Phone 2 ports on the Cisco ATA to register with Cisco Call Manager. (EPIDx is not for SCCP.) SIDx can be one of the following values:
0—Disables port; port does not attempt to register with Cisco CallManager
. or <mac_address>—Uses the default Skinny ID, which is the Cisco ATA MAC address (MAC) for the Phone 1 port and MAC[1-5]+01 for the Phone 2 port. The port attempts to register with Cisco CallManager.
For example, if the MAC address of the Cisco ATA is 0001.2D01.073D, then SID0 is 0001.2D01.073D and SID1 is 012D.0107.3D01.
Other values are reserved.
Value Types
Alphanumeric string for each parameter
Range
Maximum 51 characters for each parameter
Voice Configuration Menu Access Codes
46 and 47 for EPID0orSID0 and EPID1orSID1, respectively
CA0orCM0 and CA1orCM1
Description
CMx specifies the IP address (with an optional port number) or the URL of the primary or secondary Cisco CallManager to which the Cisco ATA should register. Use the CM0 parameter for the primary Cisco CallManager and the CM1 parameter for the secondary Cisco CallManager parameter. (CAx is not for SCCP.)
Note Use this parameter only if the default Cisco CallManager TFTP method is not desirable for configuring
the Cisco CallManager IP address, in which case you must set the UseTftp parameter to 0.
If you specify a Cisco CallManager port, you must separate the port number from the host IP address with a colon (:).
This parameter (UseMGCP) is located in the yellow portion of the Cisco ATA web configuration page. The other parameters in this portion of the screen are not for SCCP.
UseMGCP
Description
Set this parameter to 0 if you are using the Cisco ATA as an SCCP client. (Set this parameter to 1 if you are using the Cisco ATA as an MGCP client.)
Value Type
Boolean
Range
0 or 1
Default
0
Voice Configuration Menu Access Code
38
Other Parameters
This remaining parameters in the yellow portion of the configuration screen are not used for SCCP:
CA0UID
CA1UID
MGCPVer
RetxIntv
RetxLim
MGCPPort
CodecName
Operating Parameters
The parameters described in this section include parameters for configuring codecs, fax features and VLAN settings:
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)
This parameter is used for the audio operating mode. The lower 16 bits are for the Phone 1 FXS port, and the upper 16 bits are for the Phone 2 FXS port. Table 5-1 provides definitions for each bit.
0/1—Disable/enable G.711 silence suppression for all codecs.
Note When Bit 0 is set to 1, the Cisco ATA checks the silence suppression setting on the Cisco CallManager to determine if silence suppression should be applied to the call. When Bit 0 is set to 0, the Cisco ATA will not use silence suppression regardless of the silence suppression setting on the Cisco CallManager.
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-15
Reserved.
ConnectMode
Description
This parameter is a 32-bit bitmap to control the connection mode of the selected call signalling protocol. Table 5-2 provides bit definitions for this parameter.
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
Specifies the fax pass-through NSE payload type. 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.
13
0—Use G.711µ-lawfor fax pass-through codec.
1—Use G.711A-law for fax pass-through codec.
14-15
0—Use fax pass-through.
1—Use codec negotiation in sending fax.
2,3—Reserved.
16-20
Reserved.
21
0—Enable G729 on the Phone 1 FXS port.
1—Enable G729 on the Phone 2 FXS port.
22-27
Reserved.
28-29
0—Select the Cisco ATA Style for mid-call services. Services are call hold/resume, call transfer and conference call.
1—Select the Bellcore Style for mid-call services. Services are call transfer and conference call.
2—Select the Cisco VG248 Style for mid-call services. Services are three-way calling, call transfer and conference call.
0/1—Disable/enable Cisco IOS Telephony Solution (ITS). Cisco ITS runs on an IOS router and is a subset of Cisco CallManager. If you have Cisco ITS, refer to the documentation for that product.
31
0 - Disable XML configuration file support (use if you are running Cisco CallManager version 3.0).
1 - Enable XML configuration file support (use if you are running Cisco CallManager version 3.1 or later).
CallerIdMethod
Description
This 32-bit parameter specifies the signal format to use for both FXS ports for generating Caller ID format. Possible values are:
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—Use these bits for setting the maximum number of digits in the phone number portion (valid values are 1 to 20).
Bit 9 to 14—Use these bits for setting the maximum number of digits in the name number portion (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—These bits are for the Start digit (valid values are 12 for "A," 13 for "B," 14 for "C," and 15 for "D.").
Bits 7-10—These bits are for the End digit (valid values are 11 for "#," 12 for "A," 13 for "B," 14 for "C," and 15 for "D.").
Bits 11—This bit is for setting polarity reversal before and after the Caller ID signal (value of 0/1 disables/enables polarity reversal).
Bits 12-16—These bits are for the maximum number of digits in the 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.
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.
The Cisco ATA uses the value of this parameter for a DNS search if either the TftpUrl or CM0orCA0 parameters do not contain a fully qualified domain name. For example, if cm1 is specified as the Cisco CallManager URL, and cisco.com is the value of the Domain parameter, then the Cisco ATA uses cm1@cisco.com for its DNS search.
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.
Not used for SCCP. For information about RTP packet size configuration, which is controlled by the Cisco CallManager, refer to your Cisco CallManager documentation.
UDPTOS
Description
Use this parameter to specify the default 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
Use this parameter to enable/disable various operational features.
See Table 5-3 for bit definitions of this parameter.
The following list contains the names of the call-progress tone parameters:
DialTone
BusyTone
ReorderTone
RingBackTone
CallWaitTone
ConfirmTone
Tone Parameter Syntax
Each tone is specified by nine integers, as follows:
ntone, freq0, freq1, level0, level1, steady, on-time, off-time, total-tone- time
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 ^ 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:
Brief descriptions, and lists of default values and the voice configuration menu code for each Cisco ATA tone parameter, appear in the following sections:
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.
This parameter is for specifying the inside dial tone in SCCP. The outside dial tone in SCCP is fixed at 450Hz+540Hz@-6dBm. The inside dial tone is the tone that the telephone plays when a phone inside the PBX goes off-hook. The outside dial tone is the tone that the telephone plays when a phone inside the PBX is connected to the PSTN.
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.
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.
