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, page 5-3
• Parameters for Configuration Method and Encryption, page 5-4
• Network Configuration Parameters, page 5-8
• H.323 Parameters, page 5-13
• Audio Configuration Paramete rs, page 5-21
• Operational Parameters, page 5-26
• Te lephon e Configuration Parameters, page 5-3 7
• Tone Configuration Parameters, page 5-41
• Dial Plan Parameters, page 5-52
• Diagnostic Parameters, page 5-60
• CFGID—Version Parameter for C isco ATA Configuration File, page 5-63
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)
NoteBits are numbered from right to left, starting with bit 0.
OL-4804-01
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-1
Configuration Text File Template
NoteThe 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 A TA 186 and Cisco ATA 188 are explicitly stated.
NoteThis section contains recommended values for the United States and other countries as configuration
examples for certain parameters. F or detailed recommendations of tone-parameter values by country , see
Appendix E, “Recommended Cisco ATATone Parameter Values by Country.”
Chapter 5 Parameters and Defaults
NoteA tool called bitaid.exe is bundled with your Cisco ATA software. You can use this tool
to help you configure values of Cisco A TA bitmap parameters. The tool prompts you for
the necessary information.
–
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
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 f ile
or Cisco ATA-specific configuration file. For instructions on how to create these conf iguration f iles, see
the “Creating Unique and Common Cisco ATA Configuration Files” section on page 3-9.
The h323_example.txt file contain s all the Cisco A TA default values. The sections that follo w this list ing
describe all the parameters in this file.
The 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 on page 5-34.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-3
Parameters for Configuration Method and Encryption
To clear a pa ssword, change the value to 0.
You cannot recover a forgotten passw ord unless you reset the enti re conf iguration of the Cisco AT A (see
the “Resetting the Cisco ATA to Factory Default Values” section on page 3-23).
NoteWhen 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
Chapter 5 Parameters and Defaults
Related Parameter
OpFlags, page 5-34—Bit 7
Parameters for Configuration Method and Encryption
This section describes parameters for in structing the Cisco A TA about how to locate its TFTP server and
how to encrypt its configuration file:
• UseTFTP, page 5-4
• TftpURL, page 5-5
• CfgInterval, page 5-6
• EncryptKey, page 5-6
• EncryptKeyEx, page 5-7
UseTFTP
Settings
1—Use the TFTP server for Cisco ATA configuration.
0—Do not use the TFTP server for Cisco ATA configuration.
5-4
Value Type
Boolean
Range
0 or 1
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
Chapter 5 Parameters and Defaults
Default
1
Voice Configuration Menu Access Code
305
Related Parameters
• TftpURL, page 5-5
• EncryptKey, page 5-6
• EncryptKeyEx, page 5-7
• OpFlags, page 5-34—bits 0 and 3
• CfgInterval, page 5-6
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.
Parameters for Configuration Method and Encryption
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.
NoteFrom the voice configurat ion menu, you can only enter the I P address; from the web server , you can ent er
the actual URL.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
905
Related Parameters
• UseTFTP, page 5-4
• CfgInterval, page 5-6
OL-4804-01
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-5
Parameters for Configuration Method and Encryption
CfgInterval
Description
Use this parameter to specify the number of seconds between each conf iguration update. The Cisco A TA
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
Chapter 5 Parameters and Defaults
EncryptKey
NoteCisco recommends using the stronger Cisco ATA encryption method, which requires the use of the
Voice Configuration Menu Access Code
80002
Related Parameters
• UseTFTP, page 5-4
• TftpURL, page 5-5
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 A TA configuration file on the TFTP server is not encrypted.
EncryptKeyEx parameter. For more information, see the “EncryptKeyEx” section on page 5-7.
5-6
For examples on how to upgrade from the EncryptK e y parameter to the stronger encrypti on method that
uses the EncryptKeyEx parameter, see the “Examples of Upgrading to Stronger Encryption Ke y” section
on page 3-15.
Value Type
Hexadecimal string
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
Chapter 5 Parameters and Defaults
Range
Maximum number of characters: 8
Default
0
Voice Configuration Menu Access Code
320
Related Parameters
• UseTFTP, page 5-4
• TftpURL, page 5-5
• EncryptKeyEx, page 5-7
EncryptKeyEx
Parameters for Configuration Method and Encryption
Description
This parameter specifies an encryption key that is stronger than the key specified with the Encry ptKey
parameter. This stronger key is used to encrypt the Cisco ATA configuration file on the TFTP server.
NoteCisco recommends using the EncrpytKeyEx parameter instead of the EncryptKey parameter for the
strongest possible encryption of the Cisco ATA configuration file.
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 f ile (see the “Using Encryption W ith th e 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.
NoteThe cfgfmt tool (version 2.3) program generate an ata<macaddress>.x file in addition to an
ata<macaddress> file if the EncryptKeyEx parameter is specified. You should place both such
configuration files on the TFTP server.
OL-4804-01
For examples on how to upgrade from the EncryptK e y parameter to the stronger encrypti on method that
uses the EncryptKeyEx parameter, see the “Examples of Upgrading to Stronger Encryption Ke y” section
on page 3-15.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-7
Network Configuration Parameters
Value Type
Hexadecimal string of the form:
Rc4PasswdInHex/macinHex_12
• rc4KeyInHex_n is a hexadecimal string of one to 64 characters.
• /macInHex_12 is the optional extension consisting of a forward slash ( / ) followed by the six-byte
MAC address of the Cisco ATA to which the configuration file will be downloaded.
Range
Maximum number of characters: 64
Default
0
Voice Configuration Menu Access Code
Not applicable for this parameter.
Related Parameters
• UseTFTP, page 5-4
• TftpURL, page 5-5
Chapter 5 Parameters and Defaults
• EncryptKey, page 5-6
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, page 5-8
• StaticIp, page 5-9
• StaticRoute, page 5-9
• StaticNetMask, page 5-10
• NTPIP, page 5-10
• AltNTPIP, page 5-11
• DNS1IP, page 5-11
• DNS2IP, page 5-12
• VLANSetting, page 5-12
DHCP
5-8
Description
A DHCP server can be used to automatically set the Cisco A TA IP address, the network route IP address,
the subnet mask, DNS, NTP, TFTP, and other parame ters.
• 1—Enable DHCP
• 0—Disable DHCP
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
Chapter 5 Parameters and Defaults
Value Type
Boolean
Range
0 or 1
Default
1
Voice Configuration Menu Access Code
20
Related Parameters
• StaticIp, page 5-9
• StaticRoute, page 5-9
• StaticNetMask, page 5-10
• OpFlags, page 5-34—Bits 3 and 11
Network Configuration Parameters
StaticIp
StaticRoute
Description
Use this parameter to statical ly 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
• DHCP, page 5-8
• StaticRoute, page 5-9
• StaticNetMask, page 5-10
OL-4804-01
Description
Use this parameter to statically assign the Cisco ATA route if the DHCP parameter is set to 0.
Value Type
IP address
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-9
Network Configuration Parameters
Default
0.0.0.0
Voice Configuration Menu Access Code
2
Related Parameters
StaticNetMask
Description
Use this parameter to statical ly assign the Cisco ATA subnet mask if the DHCP parameter is set to 0
Chapter 5 Parameters and Defaults
• DHCP, page 5-8
• StaticIp, page 5-9
• StaticNetMask, page 5-10
NTPIP
Value Type
IP address
Default
255.255.255.0
Voice Configuration Menu Access Code
10
Related Parameters
• DHCP, page 5-8
• StaticIp, page 5-9
• StaticRoute, page 5-9
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.
5-10
The user must not specify a port parameter. The Cisco ATA uses the default NTP port only.
Value Type
IP address
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
Chapter 5 Parameters and Defaults
Default
0.0.0.0
Voice Configuration Menu Access Code
141
Related Parameters
• AltNTPIP, page 5-11
• TimeZone, page 5-36
AltNTPIP
Description
This parameter is the alternate NTP IP address, if you want redun dancy. You can set this parameter to 0
or point to the same NTPIP if only one NTP server ex ists.
Value Type
IP address
Network Configuration Parameters
DNS1IP
Default
0.0.0.0
Voice Configuration Menu Access Code
142
Related Parameters
• NTPIP, page 5-10
• TimeZone, page 5-36
Description
This parameter is for setting the primary domain name serv er (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
OL-4804-01
Default
0.0.0.0
Voice Configuration Menu Access Code
916
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-11
Network Configuration Parameters
DNS2IP
Chapter 5 Parameters and Defaults
Description
This parameter is for setting the secondary domain name server (DNS) IP address, if th e 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:
• Bits 0-2—Specify VLAN Class of Service (CoS) bit value (802.1P pri ority) for signali ng IP packets.
• Bits 3-5—Specify VLAN CoS bit value (802.1P priority) for voice IP 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
Related Parameter
OpFlags, page 5-34
5-12
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
Chapter 5 Parameters and Defaults
H.323 Parameters
This sections describes the following parameters, which include H.323 Gatekeeper configuration
parameters:
• GkOrProxy, page 5-13
• GkId, page 5-14
• GkTimeToLive, page 5-14
• AltGk, page 5-14
• AltGkTimeOut, page 5-15
• UID0, page 5-16
• PWD0, page 5-16
• UID1, page 5-17
• PWD1, page 5-18
• LoginID0, page 5-18
• LoginID1, page 5-19
H.323 Parameters
GkOrProxy
• UseLoginID, page 5-19
• AutMethod, page 5-20
• Gateway, page 5-20
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
OL-4804-01
Related Parameters
• AltGk, page 5-14
• AltGkTimeOut, page 5-15
• GkTimeToLive, page 5-14
• GkId, page 5-14
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-13
H.323 Parameters
GkId
Chapter 5 Parameters and Defaults
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
AltGk
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
Description
You have the option of using this parameter to statically specify the IP address of an alternate H.323
gatekeeper.
5-14
Value Type
Alphanumeric string
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
Chapter 5 Parameters and Defaults
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
6
Related Parameter
AltGkTimeOut, page 5-15
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 on
page 5-32) determines whether the Cisco ATA re-registers with the H.323 gatekeeper.
H.323 Parameters
Value Type
Integer
Default
0—The Cisco ATA continues to use the backup gatekeeper until i t fa ils before attemptin g to f ail back to
the primary gatekeeper.
Range
30 to 4294967295 seconds
Voice Configuration Menu Access Code
251
Related Parameters
• AltGk, page 5-14
• ConnectMode, page 5-32—Bit 3
OL-4804-01
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-15
H.323 Parameters
UID0
Chapter 5 Parameters and Defaults
Description
This parameter is the User ID (E.164 phone number) for the Phone 1 port. If the valu e 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
PWD0
Related Parameters
• UID1, page 5-17
• PWD0, page 5-16
• PWD1, page 5-18
• UseLoginID, page 5-19
• LoginID0, page 5-18
• LoginID1, page 5-19
Description
This parameter is the password for the Phone 1 port.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
5-16
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
Chapter 5 Parameters and Defaults
Voice Configuration Menu Access Code
4
Related Parameters
• UID0, page 5-16
• UID1, page 5-17
• PWD1, page 5-18
• UseLoginID, page 5-19
• LoginID0, page 5-18
• LoginID1, page 5-19
• AutMethod, page 5-20
UID1
Description
This parameter is the User ID (E.164 phone number) for the Phone 2 port. If the valu e is set to zero, the
port will be disabled and no dial tone will sound.
H.323 Parameters
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
13
Related Parameters
• UID0, page 5-16
• PWD0, page 5-16
• PWD1, page 5-18
• UseLoginID, page 5-19
• LoginID0, page 5-18
• LoginID1, page 5-19
OL-4804-01
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-17
H.323 Parameters
PWD1
Chapter 5 Parameters and Defaults
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
• UID0, page 5-16
• UID1, page 5-17
• PWD0, page 5-16
LoginID0
• UseLoginID, page 5-19
• LoginID0, page 5-18
• LoginID1, page 5-19
• AutMethod, page 5-20
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 paramet er values are identical, only one gatekeeper registration is
performed for both ports, in which case the LoginID0 va lue 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
5-18
Default
0
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
Chapter 5 Parameters and Defaults
Voice Configuration Menu Access Code
46
Related Parameters
• LoginID1, page 5-19
• PWD0, page 5-16
• PWD1, page 5-18
• UseLoginID, page 5-19
• AutMethod, page 5-20
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.
H.323 Parameters
If the LoginID0 and LoginID1 parameter values are identical, only one gatekeeper registration is
performed for both ports, in which case the LoginID0 va lue 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
• LoginID0, page 5-18
• PWD0, page 5-16
• PWD1, page 5-18
• UseLoginID, page 5-19
• AutMethod, page 5-20
UseLoginID
OL-4804-01
Description
0—Use UID0 and UID1 as the authentication ID.
1—Use LoginID0 and LoginID1 as the authentication ID.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-19
H.323 Parameters
AutMethod
Chapter 5 Parameters and Defaults
Value Type
Boolean
Range
0 or 1
Default
0
Voice Configuration Menu Access Code
93
Description
Use this parameter to select the desired authentication method, with the following possible values:
• 0—Do not use authentication (default)
• 1—Use Cisco registration-level security
• 2—Use Cisco administration-level security on a per-call basis
Gateway
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
92
Related Parameters
• LoginID0, page 5-18
• LoginID1, page 5-19
• PWD0, page 5-16
• PWD1, page 5-18
• NTPIP, page 5-10
• AltNTPIP, page 5-11
Description
Use this parameter to specify the H.323 gat eway 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.
5-20
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
Loading...
+ 44 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.