|
|
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 sip_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 sip_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:0DNS1IP:0.0.0.0DNS2IP:0.0.0.0NTPIP:0.0.0.0AltNTPIP:0.0.0.0VLANSetting:0x0000002bGkOrProxy:0AltGk:0AltGkTimeOut:0UID0:0UID1:0PWD0:0PWD1:0LoginID0:0LoginID1:0UseLoginID:0SIPPort:5060SIPRegOn:0SIPRegInterval:120MaxRedirect:5SipOutBoundProxy:0NATIP:0NatServer:0NatTimer:0MsgRetryLimits:0x00000000SessionTimer:0x00000000SessionInterval:1800MinSessionInterval:1800DisplayName0:0DisplayName1: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:0x00060000OpFlags:0x2TimeZone: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,1920SITone:2,30467,28959,1191,1513,0,2000,2000,0RingOnOffTime: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 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 prompt the user for this password when the user attempts 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
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:
•
•
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
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
•
•
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
Related Parameter
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
Related Parameter
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
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
VLANSetting
Description
This parameter is for specifying VLAN-related settings.
Bitmap definitions are as follows for the VLANSetting parameter:
•
•
•
•
•
Value Type
Bitmap
Default
0x0000002b
Voice Configuration Menu Access Code
324
Related Parameter
SIP Configuration Parameters
This section describes the following parameters, which include SIP port and SIP proxy configuration parameters:
•
•
•
•
•
•
•
•
•
•
•
GkOrProxy
Description
This parameter is the proxy address or registrar address.
For a SIP proxy server, this can be an IP address with or without a port parameter such as 123.123.110.45, 123.123.110.45.5060, or 123.123.110.45:5061, or a URL such as sip.cisco.com, or sip.ata.cisco.com:5061. For an IP address, a '.' or ':' can be used to delimit a port parameter. For a URL, a ':' must be used to indicate a port.
The default port is port number 5060.
Note
If the hostname specified in GkOrProxy is not an IP address (but is, for example, a domain name), the Cisco ATA performs a DNS A-record query on the domain name. To force the Cisco ATA to perform a DNS SRV query first, you must set ConnectMode parameter bit 29 to a value of 1. (See the "ConnectMode" section.) If the query results in a zero DNS SRV entry, then the Cisco ATA performs a DNS A-record query on the hostname.
If the SRV lookup returns two hosts, they become primary and backup proxies according to their priority (as specified in the DNS SRV RFC), and the hostname specified in the AltGk parameter is ignored.
If the SRV lookup returns only one host, this host is the primary proxy, and the hostname specified in the AltGk parameter is the backup proxy.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0—Disables proxy registration and proxy-routed calls.
In this case, you can make direct IP calls by dialing the user-id@IP:port of the callee, where user-id must be a numeric value, '@' is dialed as "**", and '.' and ':' are dialed as a '*'.
The following list shows some examples of direct SIP IP dialing:
•
•
•
Voice Configuration Menu Access Code
5
AltGk
Description
You have the option of using this parameter to specify a backup proxy. However, if a DNS SRV performed on the GkOrProxy parameter returns more than one host, the AltGk parameter is ignored. For more information, refer to the description and syntax examples in the "GkOrProxy" section.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
6
AltGkTimeOut
Description
You can use this parameter to specify the timeout in seconds before the Cisco ATA fails back to the primary proxy server from the backup proxy server. Re-registration does not occur until the current registration period expires.
Value Type
Integer
Default
0—The Cisco ATA continues to use the backup proxy server until it fails before attempting to fail back to the primary proxy server.
Range
30 to 4294967295 seconds
Voice Configuration Menu Access Code
251
UID0
Description
This parameter is the User ID (for example, the 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.
Use this parameter for registration and authentication. If a proxy server requires separate registration and authentication IDs, use this parameter to specify the registration ID only. You can use the LoginID0 parameter specify the authentication ID.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
3
Related Parameter
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
UID1
Description
This parameter is the User ID (for example, the 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.
Use this parameter for registration and authentication. If a proxy server requires separate registration and authentication IDs, use this parameter to specify the registration ID only. You can use the LoginID1 parameter specify the authentication ID.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
13
Related Parameter
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
LoginID0
Description
If a proxy server requires separate registration and authentication IDs, use this parameter to specify the authentication ID for the Phone1 port of the Cisco ATA.
Note
Value Type
Alphanumeric string
Range
Maximum number of characters: 51
Default
0
Voice Configuration Menu Access Code
46
Related Parameters
•
LoginID1
Description
If a proxy server requires separate registration and authentication IDs, use this parameter to specify the authentication ID for the Phone2 port of the Cisco ATA.
Note
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
SIPPort
Description
This parameter is used to configure the port through which the Cisco ATA listens for incoming SIP requests and sends outgoing SIP requests.
Value Type
Integer
Range
1 to 65535
Default
5060
Voice Configuration Menu Access Code
201
SIPRegInterval
Description
Use this parameter to configure the number of seconds between Cisco ATA registration renewal with the SIP proxy server. The Cisco ATA renews the registration at some percentage of time earlier than the specified interval to prevent a registration from expiring.
Value Type
Integer
Range
1 to 86400
Default
3600
Voice Configuration Menu Access Code
203
SIPRegOn
Description
0—Disable SIP registration.
1—Enable SIP registration. When this flag is enabled, the Cisco ATA registers with the SIP Proxy Server that is specified in the GkorProxy parameter. The Cisco ATA also registers with the interval that is specified in the SIPRegInterval parameter.
Value Type
Boolean
Range
0 or 1
Default
0
Voice Configuration Menu Access Code
204
MAXRedirect
Description
This parameter specifies the maximum number of times that a called number is allowed to forward the call to another number.
Value Type
Integer
Range
0 to 10
Default
5
Voice Configuration Menu Access Code
205
SipOutBoundProxy
Description
The SIP Outbound Proxy Server is a SIP proxy server which can be different from the Registration Proxy Server (specified in the GkOrProxy parameter) and to which all outgoing SIP requests are sent. Outgoing SIP responses are not affected by this out-bound-proxy and are still sent according to the VIA header and source address of the incoming SIP requests.
If the outgoing SIP request has a ROUTE header, the first route in the header is removed if it resolves to the same IP address as the out-bound-proxy. This process guards against the case when the out-bound-proxy also inserts its IP address into the RECORD-ROUTE header.
The OutBoundProxy parameter can be an IP address with or without a port parameter, such as 123.123.110.45, 123.123.110.45.5060, or 123.123.110.45:5061, or a URL such as sip.cisco.com, sip.ata.cisco.com:5061. For IP addresses, a period (.) or colon (:) can be used to delimit a port parameter. For a URL, a colon (:) must be used to indicate a port. If no port parameter is specified, the port 5060 is assumed.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
206
NATIP
Description
This is the WAN address of the attached router/NAT; currently only used to support SIP behind a NAT.
Value Type
IP address
Default
0.0.0.0
Voice Configuration Menu Access Code
200
NatServer
Description
This parameter allows you to specify the server to which dummy, single-byte UDP packets are sent to maintain a NAT translation for a session.
The parameter value can be an IP address with or without a port parameter (such as 123.123.110.45 or 123.123.110.45:5060), or a URL(such as nat.cisco.com or dummy.cisco.com:5061).
Syntax
<IP_address>[<.|:><Port>] | <URL>[:<Port>]The following syntax rules apply:
•
•
•
•
Value Type
IP address or FQDN format
Range
Maximum number of characters: 47
Default
5060 is the default port if no port is specified.
Voice Configuration Menu Access Code
207
NatTimer
Description
The NatTimer parameter provides the following configuration:
•
•
•
See Table 5-1 for definitions of each bit.
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
208
MsgRetryLimits
Description
This parameter is a bitmap that allows you to specify the number of times that the Cisco ATA retransmits various SIP requests to the current proxy as well as the number of times that the Cisco ATA sends responses to specific requests from the SIP user agent.
When the Cisco ATA sends a SIP message to the remote SIP user agent, the message does not always reach its destination for various reasons. When this occurs, the Cisco ATA re-sends the same message a specified number of times before timing out.
The number of retries is configurable for the following Cisco ATA SIP requests:
•
•
•
•
•
•
The number of retries is also configurable for the following Cisco ATA responses to requests from the SIP user agent:
•
•
See Table 5-2 for definitions of each bit.
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
360
SessionTimer
Description
Use this parameter to configure various options of the SIP session timer. See Table 5-3 for bit definitions.
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
362
Examples
•
With this setting, the Cisco ATA accepts requests from the far end for a session timer but never initiates requests for a session timer.
By default, the Cisco ATA will not be the session refresher except if one of the following conditions is true:
–
–
•
With this setting, the Cisco ATA is always the requester of a session timer, providing the following condition is true:
–
By default, the Cisco ATA will not be the session refresher except if one of the following conditions is true:
–
–
•
With this setting, the Cisco ATA only accept requests from the far end for a session timer but never initiates requests for a session timer.
By default, the Cisco ATA will not be the session refresher except if one of the following conditions is true:
–
–
•
With this setting, the Cisco ATA is always the requester of a session timer, providing the following condition is true:
–
In this mode, the Cisco ATA is designated as the session refresher except if one of the following conditions is true:
–
–
Related Parameters
SessionInterval
Description
Use this parameter to configure the interval, in number of seconds, between SIP session refreshes.
Conditions for Usage
One of the following conditions must exist for this parameter to be used:
•
In this case, bits 0 and 1 of the SessionTimer parameter must be enabled.
•
–
–
Value Type
Integer
Range
60 to 86400 seconds
Default
1800 seconds (one half hour)
Voice Configuration Menu Access Code
363
Related Parameters
MinSessionInterval
Description
This parameter is used only if the Cisco ATA is the callee and if the caller has requested the use of a session timer. The Cisco ATA then uses this parameter to validate the requested refresh interval.
Use this parameter to configure the minimum required interval, in number of seconds, between session refreshes.
If the Session-Expires value in the INVITE request sent to the Cisco ATA is smaller than the value of the MinSessionInterval parameter, the Cisco ATA will reject the INVITE request and return a 422 Session Interval Too Small message to the caller.
If the Session-Expires value in the received INVITE request is greater than or equal to the Cisco ATA MinSessionInterval, the Cisco ATA will accept this interval by sending a 200 OK message to the caller with the refresh interval listed in the Session-Expires field and the Required:timer line included in the Cisco ATA response.
Value Type
Integer
Range
60 to 86400 seconds
Default
1800
Voice Configuration Menu Access Code
364
Related Parameters
DisplayName0
Description
For caller ID purposes, you can configure a name to correspond to the phone number of the Cisco ATA Phone 1 input port. This name will be displayed at the remote endpoint when a call originates from this Cisco ATA.
Value Type
Alphanumeric string
Range
Maximum 31 characters
Default
0. This means that a display name will not be included in any SIP messages.
Voice Configuration Menu Access Code
5002
DisplayName1
Description
For caller ID purposes, you can configure a name to correspond to the phone number of the Cisco ATA Phone 2 input port. This name will be displayed at the remote endpoint when a call originates from this Cisco ATA.
Value Type
Alphanumeric string
Range
Maximum 31 characters
Default
0. This means that a display name will not be included in any SIP messages.
Voice Configuration Menu Access Code
5003
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, 6
Default
2
Voice Configuration Menu Access Code
36
TxCodec
Description
Use this parameter to specify the transmitting-audio codec preference. The following values are valid:
•
•
•
•
•
Value Type
Integer
Range
0-3, 6
Default
2
Voice Configuration Menu Access Code
37
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, two G.726 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.
When G.726 is selected, the Cisco ATA can support as many as two active simultaneous G.726 connections. The allocation of the G.726 codec is dynamic. Two G.726 connections can be used by one Cisco ATA voice port for conferencing or shared by two Cisco ATA voice ports.
The following values are valid:
•
•
•
Value Type
Integer
Range
0, 3 or 6
Default
0
Voice Configuration Menu Access Code
300
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-4 provides definitions for each bit.
Value Type
Bitmap
Default
0x00150015
Voice Configuration Menu Access Code
312
Related Parameter
NumTxFrames
Description
Use this parameter to select the default RTP packet side in number of frames per packet. The Cisco ATA default frame sizes are as follows:
•
•
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
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-5 provides definitions of each bit.
Note
Value Type
Bitmap
Default
0xffffffff
Voice Configuration Menu Access Code
314
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-6 provides definitions of each bit.
Value Type
Bitmap
Default
0xffffffff
Voice Configuration Menu Access Code
315
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
US command table:
CallCmd: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
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-7 contains bit definitions of this parameter.
Value Type
Bitmap
Default
0x01418564
Voice Configuration Menu Access Code
318
Related Parameter
ConnectMode
Description
This parameter is a 32-bit bitmap used to control the connection mode of the selected call signaling protocol. Table 5-8 provides bit definitions for this parameter.
Value Type
Bitmap
Default
0x00060400
Voice Configuration Menu Access Code
311
Table 5-8 ConnectMode Parameter Bit Definitions
0—H.323 only
0—Enable normal start.
1—Enable fast start.
1—H.323 only
0/1—Disable/enable h245 tunneling.
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.
Default: 0
3—H.323 only
0/1—Disable/enable the requirement for the alternate gatekeeper to register.
4—H.323 only
0—Denotes a non-Cisco CallManager environment.
1—Enable the Cisco ATA to operate in a Cisco CallManager environment.
5—H.323 only
0/1—Enable/disable two-way cut-through of voice path before receiving CONNECT message.
6—H.323 only
0/1—Disable/enable using the Progress Indicator to determine if ringback is supplied by the far end with RTP.
7
0/1—Disable/enable fax pass-through redundancy.
Default: 0
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µ-law for fax pass-through codec.
1—Use G.711A-law for fax pass-through codec.
Default: 0
14-15
0—Use fax pass-through. This setting is the default.
1—Use codec negotiation in sending fax.
2—Reserved.
3—Reserved.
16
0/1—Disable/enable SIP to remove previous registrations before adding a new registration.
Default: 0
Note
17—SIP only
0/1—Disable/enable call forwarding performed by the Cisco ATA. In SIP, call forwarding can be performed locally by the Cisco ATA or it can be performed by the SIP proxy. If this bit is disabled, the Cisco ATA forwards the entire dial string, including service activation code, to the SIP proxy for processing.
Default: 1
18—SIP only
0/1—Disable/enable SIP call return performed by the Cisco ATA.
Default: 1
19
0/1—Disable/enable the Cisco ATA to send a ringback tone to the caller.
Default: 0
20—SIP only
0/1—Disable/enable SIP to perform action=proxy in a REGISTER message.
You cannot simultaneously set bits 20 and 21 to 1. Also, if you set both these bits 0, the action parameter is not included in the REGISTER message, forcing the proxy server to perform the next step in the call process.
Default: 0
21—SIP only
0/1—Disable/enable SIP to perform action=redirect in a REGISTER message.
Default: 0
22—SIP only
0/1—Disable/enable SIP to process a received= tag in the VIA header to extract the exernal IP addresses used by the Network Address Translation (NAT) router.
When the Cisco ATA is operating behind a NAT, the NATIP parameter must be set to the external IP address of the NAT router. This allows the correct IP address to be placed in the Contact and SDP headers.
In release 2.14 or later, you may leave the NAT IP address at the default value of "0" or "0.0.0.0" and let the ATA automatically scan the Via header for a "received=" parameter. The parameter, if present, would indicate that the Cisco ATA is operating behind a firewall.
The Cisco ATA proceeds as follows:
1.
In addition, the Cisco ATA will cancel all previous registrations and re-register with the new IP address in the Contact header. This step is performed only if registration is currently in an idle state.
2.
Default: 0
Note
23
0/1—Disable/enable user-configurable setting for call-waiting default.
If this value is 0 (default), the end user cannot configure the permanent default call-waiting setting for every call. Instead, the service provider's default call-waiting setting is used for every call.
If this value is 1, the end-user can configure the permanent default call-waiting setting for every call, thus overriding the value set by the service provider.
Default: 0
24
0/1—Disable/enable the mixing of audio and call waiting tone during a call.
Default: 0
25
0—Both the call-waiting call and active call will be dropped the instant the call-waiting user hangs up the phone.
1—This setting enables the call-waiting hang-up alert feature, which alerts call-waiting users that an active call is still on hold once the user has hung up from another call. The phone will continue to ring until the party on hold has hung up.
Note
Default: 0
26
Reserved.
27
0—The Cisco ATA does not change the user name to Anonymous in the SIP URL of the FROM and CONTACT headers in any INVITE requests even when the display name is sent as Anonymous. Also, the Cisco ATA does not change the user name to Anonymous in the o= line (also called the origin line) of the Session Description Protocol (SDP) header in SIP INVITE requests.
1—The Cisco ATA exhibits the following behavior, provided that the Caller Line Identification Restriction (CLIR) feature is enabled:
•
–
–
–
For more information and example requests showing the usage of the Anonymous user name, see the "Anonymous User Name Support for SIP INVITE Requests" section on page 4-11.
•
Default: 0
Enabling the CLIR feature
CLIR is enabled in one of two ways:
•
•
28
0/1—Disable/enable conference warning-tone setting.
If you set this value to 1, the Cisco ATA, when acting as a conference bridge, sends a three-party-conference warning tone to all parties in the conference call.
Default: 0
Specifications of the Warning Tone:
•
•
•
•
29
0—The Cisco ATA performs only a DNS A-record query on the domain name.
1—The Cisco ATA first performs a DNS SRV query on the domain name. If the response is empty, the Cisco ATA then performs a DNS A-record query on the domain name.
Default: 0
Related Parameters
•
30
0—The Cisco ATA does not change the user name to Anonymous in the TO header of any INVITE requests.
1—The Cisco ATA replaces all occurrences of a user ID in the TO header in all INVITE requests with Anonymous, regardless of whether the calling party has enabled or disabled the Caller Line Identification Restriction (CLIR) feature.
Default: 0
31
Reserved
OpFlags
Description
This parameter enables/disables various operational features.
See Table 5-9 for bit definitions of this parameter.
Value Type
Bitmap
Default
0x2
Voice Configuration Menu Access Code
323
Related Parameters
•
•
Table 5-9 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 uses 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.
Default: 0
Examples
1.
If you later attempt to access the Cisco ATA web configuration page, the following error messages will be displayed.
–
–
2.
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.
Default: 0
For more information about statically configured DNS IP addresses, see the "DNS1IP" section and the "DNS2IP" section.
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
Set this bit to 1 for voice prompt confirmation for the following services:
•
•
•
For more information, see the "Voice Prompt Confirmation for Call Waiting and Call Forwarding" section on page 4-20.
17
Set this bit to 1 for voice prompt confirmation for the following services:
•
•
•
For more information, see the "Voice Prompt Confirmation for Call Waiting and Call Forwarding" section on page 4-20.
18
Set this bit to 1 for voice prompt confirmation for the following service:
•
For more information, see the "Voice Prompt Confirmation for Call Waiting and Call Forwarding" section on page 4-20.
19
Set this bit to 1 for voice prompt confirmation for the following service:
•
For more information, see the "Voice Prompt Confirmation for Call Waiting and Call Forwarding" section on page 4-20.
20-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.
The default value for these bits is 0.
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
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:
•
•
•
•
•
•
Note
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. The SItone parameter specifies the special-information tone that the Cisco ATA plays when the called party is not found on the network. These 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 for Extended Format B is specified by 17 integers, as follows:
parameter: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-10 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-11 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
SITone
Description
The Cisco ATA plays the SITone (special information tone) if the Cisco ATA receives a 404 (Not Found) response, which indicates that the called party cannot be located on the network.
Default values (using the Basic format)
•
•
•
•
•
•
•
•
•
Voice Configuration Menu Access Code
926
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.
`B' Rule for Base Number
A base number the first part of a phone number that the Cisco ATA dials when Rule `B' is used in a dial plan. The telephone number that the Cisco ATA calls consists of the base number followed by a two-digit extension.
Rule `B' is used for voice prompt confirmation for the call-waiting and call-forwarding features. For more information, see the "Voice Prompt Confirmation for Call Waiting and Call Forwarding" section on page 4-20.
To set a base number, use `B' followed by the desired base number. For example, if the desired base number is 1234, you would add the rule `B1234' to your dial plan.
Syntax
Bnnnnwhere nnnn is the base number.
Example
If the administrator has configured a base number of 1234 and call forward on busy (extension 03) is enabled, the called number is 123403.
`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
TraceFlags
Description
Use this parameter to turn on specific trace features for diagnostic use. Bit values are as follows:
•
–
–
–
•
•
Recv[channel number]: <call duration in seconds> <number of recv packets>
<number of recv octets> <number of late packets>
<number of lost packets> <average network jitter in 1/8 ms>
<counts in speeding up local clock (adjustment for 10 ms each time)>
<counts in slowing down local clock (adjustment for 10 ms each time)>
Note
•
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
313
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-12 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: Thu Nov 18 11:46:51 PST 2004
All contents are Copyright © 1992--2004 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.
