Cisco Systems ATA 186 User Manual

CHAPTER
5
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.
Some parameters on the Web Configuration screen are not used for H.323; only those used for H.323 are covered in this section.
Parameters are divided into categories based on their functionality. The following categories of parameters are covered in this section:
User Interface (UI) Parameter, page 5-3
Configuration-Complete Parameter, page 5-4
Parameters for Configuration Method and Encryption, page 5-4
Network Parameters, page 5-7
Account Information Parameters, page 5-9
Gatekeeper Parameters, page 5-15
H.323 Mode Parameter, page 5-18
Operating Parameters, page 5-18
Optional Feature Parameters, page 5-35
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
OL-4008-01
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
5-1

Configuration Text File Template

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 A TA 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 Ci sco equipmen t provider for a specific country.
Configuration Text File Template
This is a listing of the example_uprofile.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-8.
The example_uprofile.txt file contains all the Cisco ATA default values. The sections that follow this listing describe all the parameters in this file.
#txt UIPassword:0 UseTftp:1 TftpURL:0 cfgInterval:3600 EncryptKey:0 ToConfig:0 upgradecode:0,0x301,0x0400,0x0200,0.0.0.0,69,0,none upgradelang:0,0x301,0x0400,0x0200,0.0.0.0,69,0,none Dhcp:1 StaticIp:0 StaticRoute:0 StaticNetMask:0 GkOrProxy:0 AltGk:0 AltGkTimeOut:0 GkTimeToLive:300 GateWay:0 GateWay2:0.0.0.0 UseLoginID:0 UID0:0 UID1:0 PWD0:0 PWD1:0 LoginID0:0 LoginID1:0 GkId:. RxCodec:1 TxCodec:1 LBRCodec:0 AudioMode:0x00150015 NumTxFrames:2 CallWaitCallerId:0x003c33d0 Polarity: 0 ConnectMode:0x00060000 AutMethod:0 TimeZone:17
Chapter 5 Parameters and Defaults
5-2
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
OL-4008-01
Chapter 5 Parameters and Defaults
NTPIP:0 AltNTPIP:0 DNS1IP:0.0.0.0 DNS2IP:0.0.0.0 UDPTOS:0xA0 RingOnOffTime:2,4,25 DialTone:2,31538,30831,1380,1740,1,0,0,1500 BusyTone:2,30467,28959,1191,1513,0,4000,4000,0 ReorderTone:2,30467,28959,1191,1513,0,2000,2000,0 RingBackTone:2,30831,30467,1943,2111,0,16000,32000,0 CallWaitTone:1,30831,0,5493,0,0,2400,2400,4800 AlertTone:1,30467,0,5970,0,0,480,480,1920 DialPlan:*St4-|#St4-|911|1>#t8.r9t2-|0>#t811.rat4-|^1t4>#.­IPDialPlan: 1 CallCmd:Af;AH;BS;NA;CS;NA;Df;EB;Ff;EP;Kf;EFh;HQ;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; SIPPort:5060 SIPRegOn:0 SIPRegInterval:120 MaxRedirect:5 OutBoundProxy:0 NatServer:0 NatTimer:0 NPrintf:0 TraceFlags:0x00000000 EchoIP:192.168.2.9 SigTimer:0x01418564 OpFlags:0x2 VLANSetting:0x0000002b FeatureTimer:0x00000000

User Interface (UI) Parameter

The sections that follow describe these parameters.
User Interface (UI) 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-33.
To clear a pa ssword, change the value to 0. You cannot recover a forgotten passwo rd unless you reset the enti re conf iguration of the Cisco ATA (s ee
the “Resetting the Cisco A TA to Factory Default Values” section on page 3-18). 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.
OL-4008-01
Value Type
Alphanumeric string
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
5-3

Configuration-Complete Parameter

Range
Maximum nine characters
Default
0
Voice Configuration Menu Access Code
7387277
Related Parameters
OpFlags, page 5-33—Bit 7
Configuration-Complete Parameter
This section contains only one parameter—ToCon fig.
Chapter 5 Parameters and Defaults

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 in structing the Cisco A TA about how to locate its TFTP server and how to encrypt its configuration file:
UseTFTP, page 5-5
TftpURL, page 5-5
5-4
CfgInterval, page 5-6
EncryptKey, page 5-6
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
OL-4008-01
Chapter 5 Parameters and Defaults

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
Parameters for Configuration Method and Encryption

TftpURL

Related Parameters
TftpURL, page 5-5
EncryptKey, page 5-6
OpFlags, page 5-33—bits 0 and 3
CfgInterval, page 5-6
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 From the voice configurat ion menu, you can only enter the I P address; from the web server , you can ent er
the actual URL.
OL-4008-01
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
5-5
Parameters for Configuration Method and Encryption
Default
0
Voice Configuration Menu Access Code
905
Related Parameters
UseTFTP, page 5-5
CfgInterval, page 5-6

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.
Chapter 5 Parameters and Defaults

EncryptKey

Value Type
Decimal
Range
60 to 4294967295
Default
3600
Voice Configuration Menu Access Code
80002
Related Parameters
UseTFTP, page 5-5
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 the
EncryptKey Parameter and cfgfmt Tool” section on page 3-11), automatically enc rypts th e binary file,
using the rc4 encryption algorithm, when the EncryptKey parameter has a value other than 0.
5-6
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
OL-4008-01
Chapter 5 Parameters and Defaults
Note If the Cisco ATA configuration file is not encrypted, the value must be set to 0.
Value Type
Alphanumeric string
Range
Maximum number of characters: 8
Default
0
Voice Configuration Menu Access Code
320
Related Parameters
UseTFTP, page 5-5

Network Parameters

TftpURL, page 5-5
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:
DHCP, page 5-7
StaticIp, page 5-8
StaticRoute, page 5-8
StaticNetMask, page 5-9

DHCP

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
OL-4008-01
Value Type
Boolean
Range
0 or 1
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
5-7
Network Parameters

StaticIp

Chapter 5 Parameters and Defaults
Default
1
Voice Configuration Menu Access Code
20
Related Parameters
StaticIp, page 5-8
StaticRoute, page 5-8
StaticNetMask, page 5-9
OpFlags, page 5-33—Bits 3 and 11
Description
Use this parameter to statical ly assign the Cisco ATA IP address if the DHCP parameter is set to 0.

StaticRoute

Value Type
IP address
Default
0.0.0.0
Voice Configuration Menu Access Code
1
Related Parameters
DHCP, page 5-7
StaticRoute, page 5-8
StaticNetMask, page 5-9
Description
Use this parameter to statically assign the Cisco ATA route if the DHCP parameter is set to 0.
Value Type
IP address
5-8
Default
0.0.0.0
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
OL-4008-01
Chapter 5 Parameters and Defaults
Voice Configuration Menu Access Code
2
Related Parameters
DHCP, page 5-7
StaticIp, page 5-8
StaticNetMask, page 5-9

StaticNetMask

Description
Use this parameter to statical ly assign the Cisco ATA subnet mask if the DHCP parameter is set to 0
Value Type
IP address

Account Information Parameters

Default
255.255.255.0
Voice Configuration Menu Access Code
10
Related Parameters
DHCP, page 5-7
StaticIp, page 5-8
StaticRoute, page 5-8
Account Information Parameters
This section describes the following identification parameters:
UID0, page 5-10
PWD0, page 5-10
UID1, page 5-11
PWD1, page 5-12
Gateway, page 5-12
UseLoginID, page 5-13
LoginID0, page 5-13
OL-4008-01
LoginID1, page 5-14
AutMethod, page 5-14
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
5-9
Account Information 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-11
PWD0, page 5-10
PWD1, page 5-12
UseLoginID, page 5-13
LoginID0, page 5-13
LoginID1, page 5-14
Description
This parameter is the password for the Phone 1 port.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
5-10
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
OL-4008-01
Chapter 5 Parameters and Defaults
Voice Configuration Menu Access Code
4
Related Parameters
UID0, page 5-10
UID1, page 5-11
PWD1, page 5-12
UseLoginID, page 5-13
LoginID0, page 5-13
LoginID1, page 5-14
AutMethod, page 5-14

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.
Account Information Parameters
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
13
Related Parameters
UID0, page 5-10
PWD0, page 5-10
PWD1, page 5-12
UseLoginID, page 5-13
LoginID0, page 5-13
LoginID1, page 5-14
OL-4008-01
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
5-11
Account Information 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-10
UID1, page 5-11
PWD0, page 5-10

Gateway

UseLoginID, page 5-13
LoginID0, page 5-13
LoginID1, page 5-14
AutMethod, page 5-14
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.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
5-12
Voice Configuration Menu Access Code
11
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
OL-4008-01
Chapter 5 Parameters and Defaults

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
Account Information 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 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
46
Related Parameters
LoginID1, page 5-14
PWD0, page 5-10
OL-4008-01
PWD1, page 5-12
UseLoginID, page 5-13
AutMethod, page 5-14
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
5-13
Account Information Parameters

LoginID1

Chapter 5 Parameters and Defaults
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 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
Default
0

AutMethod

Voice Configuration Menu Access Code
47
Related Parameters
LoginID0, page 5-13
PWD0, page 5-10
PWD1, page 5-12
UseLoginID, page 5-13
AutMethod, page 5-14
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
Value Type
Bitmap
5-14
Default
0x00000000
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
OL-4008-01
Chapter 5 Parameters and Defaults
Voice Configuration Menu Access Code
92
Related Parameters
LoginID0, page 5-13
LoginID1, page 5-14
PWD0, page 5-10
PWD1, page 5-12
NTPIP, page 5-30
AltNTPIP, page 5-30

Gatekeeper Parameters

This section describes the following paramete rs that are related to H.323 gatekeeper configuration:
GkOrProxy, page 5-15
Gatekeeper Parameters

GkOrProxy

AltGk, page 5-16
AltGkTimeOut, page 5-16
GkTimeToLive, page 5-17
GkId, page 5-17
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-4008-01
Related Parameters
AltGk, page 5-16
AltGkTimeOut, page 5-16
GkTimeToLive, page 5-17
GkId, page 5-17
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323)
5-15
Loading...
+ 33 hidden pages