Home » Cisco Manuals » Telephony » Cisco ATA-186 » Manual Viewer

Cisco ATA-186 Administration Guide - Page 101

Bit Number, Definition, action=proxy, action=redirect

Add to My Manuals
Save this manual to your list of manuals

Page 101 highlights

Chapter 5 Parameters and Defaults Operating Parameters Table 5-4 ConnectMode Parameter Bit Definitions (continued) Bit Number 17-SIP only 18-SIP only 19 20-SIP only 21-SIP only 22-SIP only Definition 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. 0/1-Disable/enable SIP call return performed by the Cisco ATA. 0/1-Disable/enable the Cisco ATA to send a ringback tone to the caller. 0/1-Disable/enable SIP to perform action=proxy in a REGISTER message. 0/1-Disable/enable SIP to perform action=redirect in a REGISTER message. 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. If the "received=" parameter is in an INVITE response, the current INVITE is canceled and a new INVITE is sent with the new IP address extracted from the "received=" parameter in the Contact and SDP headers. 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. If the "received=" parameter is in a REGISTER response as a result of a REGISTER command, the Cisco ATA will cancel all previous registrations and re-register with the new IP address extracted from the "received=" parameter in the Contact header. 23 24 25-SIP only 26 to 31 Note For the Cisco ATA to automatically detect its presence behind a NAT, the SIP proxy server or remote user agent server must include the "received=" parameter in the Via header in the responses to the Cisco ATA if the proxy detects that the source address and port do not match those in the Via header. 0/1-Disable/enable the end user to specify the default call waiting state for every call. This can be done on a permanent basis. 0/1-Disable/enable the mixing of audio and call waiting tone during a call. 0/1-Disable/enable DNS lookup of hostname "From" header hostname for call return. Reserved. Note 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. OL-3410-01 Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator's Guide (SIP) 5-29

Section	Page
CiscoATA186 and CiscoATA188 Analog Telephone Adaptor Administrator’s Guide (SIP)	1
Contents	3
Preface	11
Overview	11
Audience	11
Organization	12
Conventions	12
Related Documentation	14
Obtaining Documentation	15
World Wide Web	15
Documentation CD-ROM	15
Ordering Documentation	15
Documentation Feedback	15
Obtaining Technical Assistance	16
Cisco.com	16
Technical Assistance Center	16
Cisco TAC Web Site	17
Cisco TAC Escalation Center	17
Cisco Analog Telephone Adaptor Overview	19
Session Initiation Protocol (SIP) Overview	20
SIP Capabilities	21
Components of SIP	21
SIP Clients	22
SIP Servers	22
Hardware Overview	23
Software Features	25
Voice Codecs Supported	25
Additional Supported Signaling Protocols	26
Other Supported Protocols	26
CiscoATA SIP Services	26
Fax Services	27
Methods Supported	27
Supplementary Services	28
Installation and Configuration Overview	28
Installing the CiscoATA	29
Network Requirements	30
Safety Recommendations	30
What the CiscoATA Package Includes	30
What You Need	31
Installation Procedure	31
Power-Down Procedure	34
Configuring the CiscoATA for SIP	35
Default Boot Load Behavior	36
Specifying a Preconfigured VLAN ID or Disabling VLAN IP Encapsulation	37
Steps Needed to Configure the Cisco ATA	39
Basic Configuration Steps in a TFTP Server Environment	39
Basic Configuration Steps in a Non-TFTP Server Environment	40
Configuring the Cisco ATA Using a TFTP Server	41
Setting Up the TFTP Server with CiscoATA Software	41
Configurable Features and Related Parameters	41
Creating Unique and Common CiscoATA Configuration Files	42
Using atapname.exe Tool to Obtain MAC Address	44
Using the EncryptKey Parameter and cfgfmt Tool	45
atadefault.cfg Configuration File	46
Configuring the Cisco ATA to Obtain its Configuration File from the TFTP Server	47
Using a DHCP Server	47
Without Using a DHCP Server	49
Voice Configuration Menu	49
Using the Voice Configuration Menu	50
Entering Alphanumeric Values	51
Resetting the CiscoATA to Factory Default Values	52
CiscoATA Web Configuration Page	52
Refreshing or Resetting the CiscoATA	55
Procedure to Refresh the CiscoATA	56
Procedure to Reset the CiscoATA	56
Upgrading the SIP Signaling Image	56
Basic and Additional SIP Services	57
Important Basic SIP Services	57
Required Parameters	57
Establishing Authentication	58
Setting the Codec	59
Configuring Refresh Interval	59
Additional SIP Services	59
Advanced Audio Configuration	60
Billable Features	60
Comfort Noise During Silence Period When Using G.711	61
Configurable Hook Flash Timing	61
Configurable Mixing of Call Waiting Tone and Audio	61
Configurable On-hook delay	61
Debugging Diagnostics	61
Dial Plan	62
Disabling Access To The Web Interface	62
Distinctive Ringing	62
DNS SRV Support	62
Hardware Information Display	63
NAT Gateway	63
NAT/PAT Translation	63
Network Timing	64
OutBoundProxy Support	64
Progress Tones	64
Receiver-tagged VIA header	65
Repeat Dialing on Busy Signal	65
SIP Proxy Server Redundancy	66
Stuttering Dial Tone on Unconditional Call Forward	66
User Configurable Call Waiting Permanent Default Setting	66
User Configurable Timeout On No Answer for Call Forwarding	66
Setting Up and Placing a Call Without Using a SIP Proxy	67
Configuration	67
Placing an IP Call	68
Complete Reference Table of all CiscoATA SIP Services	68
Parameters and Defaults	73
Configuration Text File Template	74
User Interface (UI) Parameter	75
UIPassword	75
Configuration Parameter	76
ToConfig	76
Parameters for Configuration Method	76
UseTFTP	76
TftpURL	77
CfgInterval	77
EncryptKey	78
Network Parameters	78
DHCP	79
StaticIp	79
StaticRoute	79
StaticNetMask	80
Account Information Parameters	80
UID0	81
PWD0	81
UID1	81
PWD1	82
GkOrProxy	82
Gateway	83
Gateway2	83
UseLoginID	83
LoginID0	84
LoginID1	84
Backup Server Parameters	85
AltGk	85
AltGkTimeOut	85
GkTimeToLive	86
GkId	86
SIP Parameters	86
UseSIP	86
SIPRegInterval	87
MAXRedirect	87
SIPRegOn	88
NATIP	88
SIPPort	89
MediaPort	89
OutBoundProxy	89
NatServer	90
NatTimer	91
Operating Parameters	91
LBRCodec	92
AudioMode	92
RxCodec	93
TxCodec	94
NumTxFrames	94
CallFeatures	95
PaidFeatures	96
CallerIdMethod	97
FeatureTimer	98
Polarity	99
ConnectMode	100
AutMethod	102
TimeZone	102
NTPIP	102
AltNTPIP	103
DNS1IP	103
DNS2IP	103
UDPTOS	104
SigTimer	104
OpFlags	106
VLANSetting	107
Optional Feature Parameters	107
NPrintf	108
TraceFlags	108
RingOnOffTime	109
IPDialPlan	110
DialPlan	110
About Dial Plan Commands	111
Dial Plan Blocking (In Rule)	113
'H' Rule to Support Hot/Warm Line	113
'P' Rule to Support Dial Prefix	114
Call-Progress Tone Parameters	114
List of Call-Progress Tone Parameters	114
Tone Parameter Syntax	114
How to Calculate Scaling Factors	115
Recommended Values	116
Specific Call-Progress Tone Parameter Information	116
CallCmd	119
Call Commands	121
Call Command Structure	121
Syntax	122
Context-Identifiers	123
Input Sequence Identifiers	124
Action Identifiers	124
Call Command Example	125
Call Command Behavior	127
Configuring and Debugging Fax Services	133
Using Fax Pass-through Mode	133
Configuring the Cisco ATA for Fax Pass-through mode	134
AudioMode	134
ConnectMode	135
Configuring Cisco IOS Gateways to Enable Fax Pass-through	135
Enable Fax Pass-through Mode	136
Disable Fax Relay Feature	137
Using FAX Mode	138
Configuring the Cisco ATA for Fax Mode	138
Configuring the Cisco ATA for Fax Mode on a Per-Call Basis	139
Configuring the Cisco IOS Gateway for Fax Mode	139
Debugging the Cisco ATA 186/188 Fax Services	139
Common Problems When Using IOS Gateways	139
Using prserv for Diagnosing Fax Problems	141
prserv Overview	141
Analyzing prserv Output for Fax Sessions	141
Using rtpcatch for Diagnosing Fax Problems	144
rtpcatch Overview	144
Example of rtpcatch	145
Analyzing rtpcatch Output for Fax Sessions	148
Using rtpcatch to Analyze Common Causes of Failure	149
rtpcatch Limitations	151
Upgrading the CiscoATA Signaling Image	153
Upgrading the Signaling Image from a TFTP Server	153
Upgrading the Signaling Image Manually	154
Preliminary Steps	155
Running the Executable File	155
Upgrade Requirements	155
Syntax	155
Upgrade Procedure	156
Confirming a Successful Signaling Image Upgrade	157
Using a Web Browser	157
Using the Voice Configuration Menu	157
Troubleshooting	159
General Troubleshooting Tips	159
Symptoms and Actions	160
Installation and Upgrade Issues	161
Debugging	162
Frequently Asked Questions	163
Contacting TAC	164
Using SIP Supplementary Services	165
Changing Call Commands	165
Cancelling a Supplementary Service	165
Common Supplementary Services	165
Caller ID	166
Call-Waiting Caller ID	166
Voice Mail Indication	166
Unattended Transfer	167
Semi-unattended Transfer	167
Fully Unattended Transfer	167
Attended Transfer	168
Making a Conference Call in the United States	168
Making a Conference Call in Sweden	168
Call Waiting in the United States	169
Call Waiting in Sweden	169
About Call Forwarding	169
Call Forwarding in the United States	169
Call Forwarding in Sweden	170
Call Return in the United States	170
Call Return in Sweden	170
Calling Line Identification Presentation	170
About Calling Line Identification Restriction	170
Calling Line Identification Restriction in the United States	171
Calling Line Identification Restriction in Sweden	171
Voice Menu Codes	173
CiscoATASpecifications	177
Physical Specifications	177
Electrical Specifications	178
Environmental Specifications	178
Immunity Specifications	178
Physical Interfaces	179
Ringing Characteristics	179
Software Specifications	179
SIP Compliance Reference Information	181
SIP Call Flows	183
Supported SIP Request Methods	183
Call Flow Scenarios for Successful Calls	184
CiscoATA-to-SIP Server—Registration without Authentication	184
CiscoATA-to-SIP Server—Registration with Authentication	185
CiscoATA-to-CiscoATA—Basic SIP to SIP Call without Authentication	188
CiscoATA-to-CiscoATA—Basic SIP to SIP Call with Authentication	194
Glossary	201

Match case Limit results 1 per page

5-29

Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (SIP)

OL-3410-01

Chapter 5

Parameters and Defaults

Operating Parameters

Note

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.

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.

18—SIP only

0/1—Disable/enable SIP call return performed by the Cisco ATA.

0/1—Disable/enable the Cisco ATA to send a ringback tone to the caller.

20—SIP only

0/1—Disable/enable SIP to perform

action=proxy

in a REGISTER message.

21—SIP only

0/1—Disable/enable SIP to perform

action=redirect

in a REGISTER message.

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:

If the "received=" parameter is in an INVITE response, the current INVITE is canceled and a new

INVITE is sent with the new IP address extracted from the "received=<NAT IP address>" parameter

in the Contact and SDP headers.

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.

If the "received=" parameter is in a REGISTER response as a result of a REGISTER command, the

Cisco ATA will cancel all previous registrations and re-register with the new IP address extracted

from the "received=<NAT IP address>" parameter in the Contact header.

Note

For the Cisco ATA to automatically detect its presence behind a NAT, the SIP proxy server

or remote user agent server

must

include the "received=" parameter in the Via header in the

responses to the Cisco

ATA if the proxy detects that the source address and port do not match

those in the Via header.

0/1—Disable/enable the end user to specify the default call waiting state for every call. This can be done

on a permanent basis.

0/1—Disable/enable the mixing of audio and call waiting tone during a call.

25—SIP only

0/1—Disable/enable DNS lookup of hostname “From” header hostname for call return.

26 to 31

Reserved.

Table 5-4

ConnectMode Parameter Bit Definitions (continued)

Bit Number

Definition