Cisco ATA186-I2, ATA188-I2-A, ATA 186, ATA 188 Administrator's Manual

Page 1
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
Corporate Headquarters
Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000
Fax: 408 526-4100
Customer Order Number: OL-4804-01
Page 2
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The following information is for FCC compliance of Class A devices: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio-frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference, in which case users will be required to correct the interference at their own expense.
The following information is for FCC compliance of Class B devices: The equipment described in this manual generates and may radiate radio-frequency energy. If it is not installed in accordance with Cisco’s installation instructions, it may cause interference with radio and television reception. This equipment has been tested and found to comply with the limits for a Class B digital device in accordance with the specifications in part 15 of the FCC rules. These specifications are designed to provide reasonable protection against such interference in a residential installation. However, there is no guarantee that interference will not occur in a particular installation.
Modifying the equipment without Cisco’s written authorization may result in the equipment no longer complying with FCC requirements for Class A or Class B digital devices. In that event, your right to use the equipment may be limited by FCC regulations, and you may be required to correct any interference to radio or television communications at your own expense.
You can determine whether your equipment is causing interference by turning it off. If the interference stops, it was probably caused by the Cisco equipment or one of its peripheral devices. If the equipment causes interference to radio or television reception, try to correct the interference by using one or more of the following measures:
• Turn the television or radio antenna until the interference stops.
• Move the equipment to one side or the other of the television or radio.
• Move the equipment farther away from the television or radio.
• Plug the equipment into an outlet that is on a different circuit from the television or radio. (That is, make certain the equipment and the television or radio are on circuits controlled by different circuit breakers or fuses.)
Modifications to this product not authorized by Cisco Systems, Inc. could void the FCC approval and negate your authority to operate the product.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
CCIP, CCSP, the Cisco Arrow logo, the Cisco Powered Network mark, Cisco Unity, Follow Me Browsing, FormShare, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Aironet, ASIST, BPX, Catalyst, CCDA, CCDP, CCIE, CCNA, CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, the Cisco IOS logo, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Empowering the Internet Generation, Enterprise/Solver, EtherChannel, EtherSwitch, Fast Step, GigaStack, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, LightStream, MGX, MICA, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, RateMUX, Registrar, ScriptShare, SlideCast, SMARTnet, StrataView Plus, Stratm, SwitchProbe, TeleRouter, The Fastest Way to Increase Your Internet Quotient, TransPath, and VCO are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and certain other countries.
All other trademarks mentioned in this document or Web site are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0304R)
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
Copyright © 2003, Cisco Systems, Inc. All rights reserved.
Page 3
Preface xi
Overview xi
Audience xi
Organization xii
Conventions xii
Related Documentation xvi
Obtaining Documentation xvi
World Wide Web xvi Documentation CD-ROM xvii Ordering Documentation xvii Documentation Feedback xvii
Obtaining Technical Assistance xvii
Cisco.com xviii Technical Assistance Center xviii
Cisco TAC Web Site xviii Cisco TAC Escalation Center xix
CONTENTS
CHAPTER
1 Cisco Analog Telephone Adaptor Overview 1-1
H.323 Overview 1-2
H.323 Terminals 1-3 H.323 Gateways 1-3 H.323 Gatekeepers 1-4 H.323 MCUs 1-4 H.323 Proxy Server 1-4
Hardware Overview 1-5
Software Features 1-7
Voice Codecs Supported 1-7 Additional Supported Signaling Protocols 1-7 Other Supported Protocols 1-7 Cisco ATA H.323 Services 1-8 Fax Services 1-9 Supplementary Services 1-9
Installation and Configuration Overview 1-9
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
iii
Page 4
Contents
CHAPTER
CHAPTER
2 Installing the Cisco ATA 2-1
Safety Recommendations 2-1
What the Cisco ATA Package Includes 2-2
What You Need 2-2
Installation Procedure 2-3
Power-Down Procedure 2-5
3 Configuring the Cisco ATA for H.323 3-1
Default Boot Load Behavior 3-2
Specifying a Preconfigured VLAN ID or Disabling VLAN IP Encapsulation 3-3
Steps Needed to Configure the Cisco ATA 3-5
Basic Configuration Steps in a TFTP Server Environment 3-5 Basic Configuration Steps in a Non-TFTP Server Environment 3-7
Configuring the Cisco ATA Using a TFTP Server 3-8
Setting Up the TFTP Server with Cisco ATA Software 3-8 Configurable Features and Related Parameters 3-8 Creating Unique and Common Cisco ATA Configuration Files 3-9
Using atapname.exe Tool to Obtain MAC Address 3-11 Using Encryption With the cfgfmt Tool 3-12
Examples of Upgrading to Stronger Encryption Key 3-15 atadefault.cfg Configuration File 3-17 Configuring the Cisco ATA to Obtain its Configuration File from the TFTP Server 3-18
Using a DHCP Server 3-18
Without Using a DHCP Server 3-20
Voice Configuration Menu 3-20
Using the Voice Configuration Menu 3-21 Entering Alphanumeric Values 3-22 Resetting the Cisco ATA to Factory Default Values 3-23
Cisco ATA Web Configuration Page 3-23
Refreshing or Resetting the Cisco ATA 3-25
Procedure to Refresh the Cisco ATA 3-26 Procedure to Reset the Cisco ATA 3-26
Obtaining Cisco ATA Configuration File After Failed Attempt 3-26
Upgrading the H.323 Signaling Image 3-26
CHAPTER
4 Basic and Additional H.323 Services 4-1
Important Basic H.323 Services 4-1
Required Parameters 4-1
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
iv
OL-4804-01
Page 5
Setting Up User IDs for the Cisco ATA 4-3 Using the Cisco ATA with an H.323 Gatekeeper 4-3
Choosing Cisco ATA Registration Mode with an H.323 Gatekeeper 4-3 Setting Up Gatekeeper Time-To-Live Value 4-4 Setting Up an Alternate H.323 Gatekeeper 4-4 Establishing Authentication with Cisco H.323 Gatekeeper 4-5
Using the Cisco ATA Without an H.323 Gatekeeper 4-6
Using the Cisco ATA With an H.323 Gateway but Without an H.323 Gatekeeper 4-6 Using Multiple Cisco ATAs Without an H.323 Gatekeeper 4-6
Setting the Audio Codecs 4-7
Additional H.323 Services 4-7
Configurable Reboot of Cisco ATA 4-8 Configuring Audio Packet Settings 4-8 Configuring Billable Features 4-8 Configuring the Call Waiting Permanent Default Setting 4-9 Configuring the Cisco ATA Refresh Interval 4-9 Configuring Hook Flash Timing 4-9 Configuring the Mixing of Call Waiting Tone and Audio 4-9 Configuring Network Ringback Tone 4-10 Configuring Reverse Audio Cut-Through Behavior 4-10 Configuring Supplementary Service Behavior and Parameters 4-10 Debugging Diagnostics 4-10 Hardware Information Display 4-10 Network Timing 4-11 Polarity Settings 4-11 Progress Tones 4-11 Selecting DTMF and Hookflash Transmission Methods 4-11 Selecting H.323 Connection and H.245 Transmission Methods 4-12 Setting Dial Plans 4-12
Contents
Complete Reference Table of all Cisco ATA H.323 Services 4-12
CHAPTER
5 Parameters and Defaults 5-1
Configuration Text File Template 5-2
User Interface (UI) Security Parameter 5-3
UIPassword 5-3
Parameters for Configuration Method and Encryption 5-4
UseTFTP 5-4 TftpURL 5-5 CfgInterval 5-6
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
v
Page 6
Contents
EncryptKey 5-6 EncryptKeyEx 5-7
Network Configuration Parameters 5-8
DHCP 5-8 StaticIp 5-9 StaticRoute 5-9 StaticNetMask 5-10 NTPIP 5-10 AltNTPIP 5-11 DNS1IP 5-11 DNS2IP 5-12 VLANSetting 5-12
H.323 Parameters 5-13
GkOrProxy 5-13 GkId 5-14 GkTimeToLive 5-14 AltGk 5-14 AltGkTimeOut 5-15 UID0 5-16 PWD0 5-16 UID1 5-17 PWD1 5-18 LoginID0 5-18 LoginID1 5-19 UseLoginID 5-19 AutMethod 5-20 Gateway 5-20
Audio Configuration Parameters 5-21
MediaPort 5-21 RxCodec 5-22 TxCodec 5-22 LBRCodec 5-23 AudioMode 5-24 NumTxFrames 5-25 TOS 5-26
Operational Parameters 5-26
CallFeatures 5-27 PaidFeatures 5-28 CallCmd 5-29
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
vi
OL-4804-01
Page 7
FeatureTimer 5-30 FeatureTimer2 5-31 SigTimer 5-31 ConnectMode 5-32 OpFlags 5-34 TimeZone 5-36
Telephone Configuration Parameters 5-37
CallerIdMethod 5-38 Polarity 5-39 FXSInputLevel 5-40 FXSOutputLevel 5-40
Tone Configuration Parameters 5-41
Tone Parameter Syntax—Basic Format 5-41 Tone Parameter Syntax—Extended Formats 5-43
Extended Format A 5-43
Extended Format B 5-44 Recommended Values 5-48 Specific Tone Parameter Information 5-48
DialTone 5-48
BusyTone 5-49
ReorderTone 5-49
RingbackTone 5-50
CallWaitTone 5-50
AlertTone 5-51 RingOnOffTime 5-51
Contents
Dial Plan Parameters 5-52
DialPlan 5-52
Dial Plan Commands 5-53
Dial Plan Rules 5-54
Dial Plan Examples 5-58 DialPlanEx 5-60 IPDialPlan 5-60
Diagnostic Parameters 5-60
NPrintf 5-61 SyslogIP 5-61 SyslogCtrl 5-62
CFGID—Version Parameter for Cisco ATA Configuration File 5-63
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
vii
Page 8
Contents
CHAPTER
CHAPTER
6 Call Commands 6-1
Call Command Structure 6-1
Syntax 6-2
Context-Identifiers 6-3 Input Sequence Identifiers 6-4 Action Identifiers 6-4
Call Command Example 6-5
Call Command Behavior 6-7
7 Configuring and Debugging Fax Services 7-1
Using Fax Pass-through Mode 7-1
Configuring the Cisco ATA for Fax Pass-through mode 7-2
AudioMode 7-2 ConnectMode 7-3
Configuring Cisco IOS Gateways to Enable Fax Pass-through 7-3
Enable Fax Pass-through Mode 7-4 Disable Fax Relay Feature 7-5
Using FAX Mode 7-6
Configuring the Cisco ATA for Fax Mode 7-6 Configuring the Cisco ATA for Fax Mode on a Per-Call Basis 7-7 Configuring the Cisco IOS Gateway for Fax Mode 7-7
CHAPTER
Debugging the Cisco ATA 186/188 Fax Services 7-7
Common Problems When Using IOS Gateways 7-7 Using prserv for Diagnosing Fax Problems 7-9
prserv Overview 7-9 Analyzing prserv Output for Fax Sessions 7-10
Using rtpcatch for Diagnosing Fax Problems 7-12
rtpcatch Overview 7-12 Example of rtpcatch 7-14 Analyzing rtpcatch Output for Fax Sessions 7-16 Using rtpcatch to Analyze Common Causes of Failure 7-18 rtpcatch Limitations 7-20
8 Upgrading the Cisco ATA Signaling Image 8-1
Upgrading the Signaling Image from a TFTP Server 8-1
Upgrading the Signaling Image Manually 8-2
Preliminary Steps 8-3 Running the Executable File 8-3
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
viii
OL-4804-01
Page 9
Upgrade Requirements 8-3 Syntax 8-4 Upgrade Procedure and Verification 8-4
Confirming a Successful Signaling Image Upgrade 8-5
Using a Web Browser 8-5 Using the Voice Configuration Menu 8-6
Contents
CHAPTER
APPENDIX
9 Troubleshooting 9-1
General Troubleshooting Tips 9-1
Symptoms and Actions 9-2
Installation and Upgrade Issues 9-3
Debugging 9-4
Using System Diagnostics 9-5
Local Tone Playout Reporting 9-9
Obtaining Network Status Prior to Getting IP Connectivity 9-10
Obtaining Network Status After Getting IP Connectivity 9-11
DHCP Status HTML Page 9-12
Real-Time Transport Protocol (RTP) Statistics Reporting 9-12
Frequently Asked Questions 9-13
Contacting TAC 9-15
A Using H.323 Supplementary Services A-1
Changing Call Commands A-1
Cancelling a Supplementary Service A-1
Common Supplementary Services A-1
Caller ID A-2 Call-Waiting Caller ID A-2 Making a Conference Call in the United States A-2 Making a Conference Call in Sweden A-3 Call Waiting in the United States A-3 Call Waiting in Sweden A-3 Calling Line Identification Presentation A-3 About Calling Line Identification Restriction A-4 Calling Line Identification Restriction in the United States A-4 Calling Line Identification Restriction in Sweden A-4
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
ix
Page 10
Contents
APPENDIX
APPENDIX
APPENDIX
B Voice Menu Codes B-1
C Cisco ATA Specifications C-1
Physical Specifications C-1
Electrical Specifications C-2
Environmental Specifications C-2
Physical Interfaces C-2
Ringing Characteristics C-3
Software Specifications C-3
D H.323 Signaling D-1
Supported H.323 Messages D-1
H.323 Signaling Scenarios D-2
H.323 Endpoint-to-Gatekeeper Registration D-2 H.323 Endpoint-to-Endpoint Call Setup with a Common Gatekeeper D-5 H.323 Call Setup from H.323 Network to Circuit Switched Network D-14
APPENDIX
G
LOSSARY
I
NDEX
E Recommended Cisco ATA Tone Parameter Values by Country E-1
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
x
OL-4804-01
Page 11
Preface
This preface includes the following sections:
Overview, page xi
Audience, page xi
Organization, page xii
Conventions, page xii
Related Documentation, page xvi
Obtaining Documentation, page xvi
Overview
Note The term Cisco ATA is used throughout this manual to refer to both the Cisco ATA 186 and the
Audience
Obtaining Technical Assistance, page xvii
The Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323) provides the information you need to install, configure and manage the Cisco ATA 186 and Cisco ATA 188 on an H.323 network.
Cisco ATA 188, unless differences between the Cisco ATA 186 and Cisco ATA 188 are explicitly stated.
This guide is intended for service providers and network administrators who administer Voice over IP (VoIP) services using the Cisco ATA. Most of the tasks described in this guide are not intended for end users of the Cisco ATA. Many of these tasks impact the ability of the Cisco ATA to function on the network, and require an understanding of IP networking and telephony concepts.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
xi
Page 12
Preface
Organization
Organization
Table 1 provides an overview of the organization of this guide.
Table 1 Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide (H.323) Organization
Chapter Description
Chapter 1, “Cisco Analog Telephone Adaptor Overview” Provides descriptions of hardware and software features of
the Cisco ATA Analog Telephone Adaptor along with a brief overview of the H.323 protocol.
Chapter 2, “Installing the Cisco ATA” Provides information about installing the Cisco ATA.
Chapter 3, “Configuring the Cisco ATA for H.323” Provides information about configuring the Cisco ATA and
the various methods for configuration.
Chapter 4, “Basic and Additional H.323 Services” Provides information about H.323 services that the
Cisco ATA supports.
Chapter 5, “Parameters and Defaults” Provides information on all parameters and defaults that you
can use to configure the Cisco ATA.
Chapter 6, “Call Commands” Provides the Cisco ATA call commands for H.323.
Chapter 7, “Configuring and Debugging Fax Services” Provides instructions for configuring both ports of the
Cisco ATA to support fax transmission.
Chapter 8, “Upgrading the Cisco ATA Signaling Image” Provides instructions for remotely upgrading Cisco ATA
software.
Chapter 9, “Troubleshooting” Provides basic testing and troubleshooting procedures for the
Cisco ATA.
Appendix A, “Using H.323 Supplementary Services” Provides end-user information about pre-call and mid-call
services.
Appendix B, “Voice Menu Codes” Provides a quick-reference list of the voice configuration
menu options for the Cisco ATA.
Appendix C, “Cisco ATA Specifications” Provides physical specifications for the Cisco ATA.
Appendix D, “H.323 Signaling” Provides Cisco ATA call flows for H.323 scenarios.
Appendix E, “Recommended Cisco ATA Tone Parameter Values by Country”
Glossary Provides definitions of commonly used terms.
Index Provides reference information.
Provides tone parameters for various countries.
Conventions
This document uses the following conventions:
Alternative keywords are grouped in braces and separated by vertical bars (for example, {x | y | z}).
Arguments for which you supply values are in italic font.
Commands and keywords are in boldface font.
Elements in square brackets ([ ]) are optional.
Information you must enter is in boldface screen font.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
xii
OL-4804-01
Page 13
Preface
Optional alternative keywords are grouped in brackets and separated by vertical bars (for example,
[x | y | z]).
Terminal sessions and information the system displays are in screen font.
Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the
publication.
Timesaver Means the described action saves time. You can save time by performing the action described in the
paragraph.
Tip Means the following information will help you solve a problem. The tips information might not be
troubleshooting or even an action, but could be useful information, similar to a Timesaver.
Conventions
Caution Means reader be careful. In this situation, you might do something that could result in equipment
damage or loss of data.
Warning
IMPORTANT SAFETY INSTRUCTIONS
This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents. Use the statement number provided at the end of each warning to locate its translation in the translated safety warnings that accompanied this device.
Statement 1071
SAVE THESE INSTRUCTIONS
Waarschuwing
BELANGRIJKE VEILIGHEIDSINSTRUCTIES
Dit waarschuwingssymbool betekent gevaar. U verkeert in een situatie die lichamelijk letsel kan veroorzaken. Voordat u aan enige apparatuur gaat werken, dient u zich bewust te zijn van de bij elektrische schakelingen betrokken risico's en dient u op de hoogte te zijn van de standaard praktijken om ongelukken te voorkomen. Gebruik het nummer van de verklaring onderaan de waarschuwing als u een vertaling van de waarschuwing die bij het apparaat wordt geleverd, wilt raadplegen.
BEWAAR DEZE INSTRUCTIES
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
xiii
Page 14
Conventions
Preface
Varoitus
Attention
Warnung
TÄRKEITÄ TURVALLISUUSOHJEITA
Tämä varoitusmerkki merkitsee vaaraa. Tilanne voi aiheuttaa ruumiillisia vammoja. Ennen kuin käsittelet laitteistoa, huomioi sähköpiirien käsittelemiseen liittyvät riskit ja tutustu onnettomuuksien yleisiin ehkäisytapoihin. Turvallisuusvaroitusten käännökset löytyvät laitteen mukana toimitettujen käännettyjen turvallisuusvaroitusten joukosta varoitusten lopussa näkyvien lausuntonumeroiden avulla.
SÄILYTÄ NÄMÄ OHJEET
IMPORTANTES INFORMATIONS DE SÉCURITÉ
Ce symbole d'avertissement indique un danger. Vous vous trouvez dans une situation pouvant entraîner des blessures ou des dommages corporels. Avant de travailler sur un équipement, soyez conscient des dangers liés aux circuits électriques et familiarisez-vous avec les procédures couramment utilisées pour éviter les accidents. Pour prendre connaissance des traductions des avertissements figurant dans les consignes de sécurité traduites qui accompagnent cet appareil, référez-vous au numéro de l'instruction situé à la fin de chaque avertissement.
CONSERVEZ CES INFORMATIONS
WICHTIGE SICHERHEITSHINWEISE
Dieses Warnsymbol bedeutet Gefahr. Sie befinden sich in einer Situation, die zu Verletzungen führen kann. Machen Sie sich vor der Arbeit mit Geräten mit den Gefahren elektrischer Schaltungen und den üblichen Verfahren zur Vorbeugung vor Unfällen vertraut. Suchen Sie mit der am Ende jeder Warnung angegebenen Anweisungsnummer nach der jeweiligen Übersetzung in den übersetzten Sicherheitshinweisen, die zusammen mit diesem Gerät ausgeliefert wurden.
Avvertenza
Advarsel
BEWAHREN SIE DIESE HINWEISE GUT AUF.
IMPORTANTI ISTRUZIONI SULLA SICUREZZA
Questo simbolo di avvertenza indica un pericolo. La situazione potrebbe causare infortuni alle persone. Prima di intervenire su qualsiasi apparecchiatura, occorre essere al corrente dei pericoli relativi ai circuiti elettrici e conoscere le procedure standard per la prevenzione di incidenti. Utilizzare il numero di istruzione presente alla fine di ciascuna avvertenza per individuare le traduzioni delle avvertenze riportate in questo documento.
CONSERVARE QUESTE ISTRUZIONI
VIKTIGE SIKKERHETSINSTRUKSJONER
Dette advarselssymbolet betyr fare. Du er i en situasjon som kan føre til skade på person. Før du begynner å arbeide med noe av utstyret, må du være oppmerksom på farene forbundet med elektriske kretser, og kjenne til standardprosedyrer for å forhindre ulykker. Bruk nummeret i slutten av hver advarsel for å finne oversettelsen i de oversatte sikkerhetsadvarslene som fulgte med denne enheten.
TA VARE PÅ DISSE INSTRUKSJONENE
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
xiv
OL-4804-01
Page 15
Preface
Conventions
Aviso
¡Advertencia!
Varning!
INSTRUÇÕES IMPORTANTES DE SEGURANÇA
Este símbolo de aviso significa perigo. Você está em uma situação que poderá ser causadora de lesões corporais. Antes de iniciar a utilização de qualquer equipamento, tenha conhecimento dos perigos envolvidos no manuseio de circuitos elétricos e familiarize-se com as práticas habituais de prevenção de acidentes. Utilize o número da instrução fornecido ao final de cada aviso para localizar sua tradução nos avisos de segurança traduzidos que acompanham este dispositivo.
GUARDE ESTAS INSTRUÇÕES
INSTRUCCIONES IMPORTANTES DE SEGURIDAD
Este símbolo de aviso indica peligro. Existe riesgo para su integridad física. Antes de manipular cualquier equipo, considere los riesgos de la corriente eléctrica y familiarícese con los procedimientos estándar de prevención de accidentes. Al final de cada advertencia encontrará el número que le ayudará a encontrar el texto traducido en el apartado de traducciones que acompaña a este dispositivo.
GUARDE ESTAS INSTRUCCIONES
VIKTIGA SÄKERHETSANVISNINGAR
Denna varningssignal signalerar fara. Du befinner dig i en situation som kan leda till personskada. Innan du utför arbete på någon utrustning måste du vara medveten om farorna med elkretsar och känna till vanliga förfaranden för att förebygga olyckor. Använd det nummer som finns i slutet av varje varning för att hitta dess översättning i de översatta säkerhetsvarningar som medföljer denna anordning.
SPARA DESSA ANVISNINGAR
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
xv
Page 16
Related Documentation
Preface
Related Documentation
RFC971 (A Survey of Data Representation Standards)
RFC768 (User Datagram Protocol)
RFC2198 (RTP Payload for Redundant Audio Data)
RFC2833 (RTP Payload for DTMF Digits, Telephony Phones and Telephony Signals)
Read Me First - ATA Boot Load Information
Cisco ATA 186 and Cisco 188 Analog Telephone Adaptor At a Glance
Regulatory Compliance and Safety Information for the Cisco ATA 186 and Cisco 188
Cisco ATA Release Notes
Obtaining Documentation
These sections explain how to obtain documentation from Cisco Systems.
World Wide Web
You can access the most current Cisco documentation on the World Wide Web at this URL:
http://www.cisco.com
Translated documentation is available at this URL:
http://www.cisco.com/public/countries_languages.shtml
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
xvi
OL-4804-01
Page 17
Preface
Documentation CD-ROM
Cisco documentation and additional literature are available in a Cisco Documentation CD-ROM package, which is shipped with your product. The Documentation CD-ROM is updated monthly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual subscription.
Ordering Documentation
You can order Cisco documentation in these ways:
Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from
the Networking Products MarketPlace:
http://www.cisco.com/cgi-bin/order/order_root.pl
Registered Cisco.com users can order the Documentation CD-ROM through the online Subscription
Store:
http://www.cisco.com/go/subscription
Obtaining Technical Assistance
Nonregistered Cisco.com users can order documentation through a local account representative by
calling Cisco Systems Corporate Headquarters (California, U.S.A.) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).
Documentation Feedback
You can submit comments electronically on Cisco.com. In the Cisco Documentation home page, click the Fax or Email option in the “Leave Feedback” section at the bottom of the page.
You can e-mail your comments to bug-doc@cisco.com.
You can submit your comments by mail by using the response card behind the front cover of your document or by writing to the following address:
Cisco Systems Attn: Document Resource Connection 170 West Tasman Drive San Jose, CA 95134-9883
We appreciate your comments.
Obtaining Technical Assistance
Cisco provides Cisco.com as a starting point for all technical assistance. Customers and partners can obtain online documentation, troubleshooting tips, and sample configurations from online tools by using the Cisco Technical Assistance Center (TAC) Web Site. Cisco.com registered users have complete access to the technical support resources on the Cisco TAC Web Site.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
xvii
Page 18
Obtaining Technical Assistance
Cisco.com
Preface
Cisco.com is the foundation of a suite of interactive, networked services that provides immediate, open access to Cisco information, networking solutions, services, programs, and resources at any time, from anywhere in the world.
Cisco.com is a highly integrated Internet application and a powerful, easy-to-use tool that provides a broad range of features and services to help you with these tasks:
Streamline business processes and improve productivity
Resolve technical issues with online support
Download and test software packages
Order Cisco learning materials and merchandise
Register for online skill assessment, training, and certification programs
If you want to obtain customized information and service, you can self-register on Cisco.com. To access Cisco.com, go to this URL:
http://www.cisco.com
Technical Assistance Center
The Cisco Technical Assistance Center (TAC) is available to all customers who need technical assistance with a Cisco product, technology, or solution. Two levels of support are available: the Cisco TAC Web Site and the Cisco TAC Escalation Center.
Cisco TAC inquiries are categorized according to the urgency of the issue:
Priority level 4 (P4)—You need information or assistance concerning Cisco product capabilities,
product installation, or basic product configuration.
Priority level 3 (P3)—Your network performance is degraded. Network functionality is noticeably
impaired, but most business operations continue.
Priority level 2 (P2)—Your production network is severely degraded, affecting significant aspects
of business operations. No workaround is available.
Priority level 1 (P1)—Your production network is down, and a critical impact to business operations
will occur if service is not restored quickly. No workaround is available.
The Cisco TAC resource that you choose is based on the priority of the problem and the conditions of service contracts, when applicable.
Cisco TAC Web Site
You can use the Cisco TAC Web Site to resolve P3 and P4 issues yourself, saving both cost and time. The site provides around-the-clock access to online tools, knowledge bases, and software. To access the Cisco TAC Web Site, go to this URL:
http://www.cisco.com/tac
All customers, partners, and resellers who have a valid Cisco service contract have complete access to the technical support resources on the Cisco TAC Web Site. The Cisco TAC Web Site requires a Cisco.com login ID and password. If you have a valid service contract but do not have a login ID or password, go to this URL to register:
http://www.cisco.com/register/
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
xviii
OL-4804-01
Page 19
Preface
If you are a Cisco.com registered user, and you cannot resolve your technical issues by using the Cisco TAC Web Site, you can open a case online by using the TAC Case Open tool at this URL:
http://www.cisco.com/tac/caseopen
If you have Internet access, we recommend that you open P3 and P4 cases through the Cisco TAC Web Si te.
Cisco TAC Escalation Center
The Cisco TAC Escalation Center addresses priority level 1 or priority level 2 issues. These classifications are assigned when severe network degradation significantly impacts business operations. When you contact the TAC Escalation Center with a P1 or P2 problem, a Cisco TAC engineer automatically opens a case.
To obtain a directory of toll-free Cisco TAC telephone numbers for your country, go to this URL:
http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml
Before calling, please check with your network operations center to determine the level of Cisco support services to which your company is entitled: for example, SMARTnet, SMARTnet Onsite, or Network Supported Accounts (NSA). When you call the center, please have available your service agreement number and your product serial number.
Obtaining Technical Assistance
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
xix
Page 20
Obtaining Technical Assistance
Preface
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
xx
OL-4804-01
Page 21
CHAPTER
1
Cisco Analog Telephone Adaptor Overview
This section describes the hardware and software features of the Cisco Analog Telephone Adaptor (Cisco ATA) and includes a brief overview of the H.323 protocol.
The Cisco ATA analog telephone adaptors are handset-to-Ethernet adaptors that allow regular analog telephones to operate on IP-based telephony networks. Cisco ATAs support two voice ports, each with an independent telephone number. The Cisco ATA 188 also has an RJ-45 10/100
This section covers the following topics:
H.323 Overview, page 1-2
Hardware Overview, page 1-5
Software Features, page 1-7
Installation and Configuration Overview, page 1-9
Figure 1-1 Cisco ATA Analog Telephone Adaptor
BASE-T data port.
OL-4804-01
CISCO ATA 186
ANALOG TELEPHONE ADAPTO
The Cisco ATA, which operates with Cisco voice-packet gateways, makes use of broadband pipes that are deployed through a digital subscriber line (DSL), fixed wireless-cable modem, and other Ethernet connections.
Note The term Cisco ATA refers to both the Cisco ATA 186 and the Cisco ATA 188, unless otherwise stated.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
R
72209
1-1
Page 22
H.323 Overview
72853
Chapter 1 Cisco Analog Telephone Adaptor Overview
Figure 1-2 Cisco ATA 186 as Endpoint in an H.323 Network
Telephone/fax
Figure 1-3 Cisco ATA 188 as Endpoint in an H.323 Network
Telephone/fax
V
Cisco ATA 186
V
Cisco ATA 188
Ethernet
Broadband CPE
(DSL, cable,
fixed wireless)
Ethernet
Broadband CPE
(DSL, cable,
fixed wireless)
Broadband
Broadband
Layer 3
IP infrastructure
H.323 Gatekeeper
Layer 3
IP infrastructure
V
V
Voice
gateway
PSTN
Voice
gateway
PSTN
H.323 Overview
H.323 is the International Telecommunication Union (ITU) standard for transmitting voice, video, and data across an IP network. Like other VoIP protocols, the H.323 standard is designed to address the functions of signaling and session management from within a packet telephony network. Signaling allows call information to be carried across network boundaries. Session management provides the ability to control the attributes of an end-to-end call. The H.323 standard includes support for call signaling and control, multimedia transport and control, and bandwidth control for both point-to-point and point-to-multipoint conferences.
The H.323 standard includes the following protocols:
Call signaling using the H.225 protocol
Media control using the H.245 protocol
G.711, G.722, G.723, G.728, and G.729 audio codecs
H.261 and H.263 video codecs
Data sharing using the T.120 protocol
Real-time transport protocol (RTP) and RTP Control Protocol (RTCP) for media transport
H.323 Gatekeeper
72854
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
1-2
OL-4804-01
Page 23
Chapter 1 Cisco Analog Telephone Adaptor Overview
Components that the H.323 standard employs include a system of interconnected voice terminals, gateways, gatekeepers, multipoint control units (MCUs), and proxy servers. Voice terminals provide point-to-point and point-to-multipoint conference capability for audio, video, and data. Voice gateways interconnect the packetized IP network to the PSTN or ISDN network. Gatekeepers provide admission control and address translation services for H.323 voice terminals and gateways. MCUs enable two or more gateways to engage in point-to-point or point-to-multipoint audio or video conferences.
This section contains descriptions of the following H.323 components:
H.323 Terminals, page 1-3
H.323 Gateways, page 1-3
H.323 Gatekeepers, page 1-4
H.323 MCUs, page 1-4
H.323 Proxy Server, page 1-4
Figure 1-4 H.323 Architecture
Multipoint Control
H.323 Gatekeeper
Unit (MCU)
H.323 Overview
Analog Phone
H.323 Terminals
Voice terminals in an H.323 network must feature system control units, media transmission capabilities, audio codecs, and network interfaces suitable for transmitting and receiving packetized data.
H.323 Gateways
H.323 gateways feature a mixture of characteristics of both standard Switched Circuit Network (SCN) access points and H.323 access points. Gateways perform the translation of audio, video, and data transmission formats as well as interacting with communications systems and various protocols. A primary responsibility of an H.323 gateway is the call setup and teardown necessary to complete a call to and from a packetized IP network and a standard switched network.
Terminal
Terminal
H.323
Network
Cisco ATA
H.323 Gateway
CSN/PSTN
72858
Analog Phone
Note Gateways are necessary in an H.323 system to connect calls over a packetized IP network to a switched
circuit network such as the PSTN.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
1-3
Page 24
H.323 Overview
H.323 Gatekeepers
Gatekeepers are primarily responsible for pre-call and call-level control services for H.323 gateways. Gatekeepers are an optional component in an H.323 system. However, if present, gatekeepers must perform the following call setup and management services:
Address translation for IP addresses originating from H.323 aliases (for example,
address_pool@cisco.com, for example) or E.164 addresses (for example, standard telephone numbers)
Admissions control for authorizing or rejecting access to H.323
Bandwidth control for gateway bandwidth requirements
Zone management for registered voice terminals, gateways and MCUs
When used in an H.323 system, gatekeepers can also (but are not required to) provide the following functionality:
Call control signaling using the gatekeeper Routed Call Signaling model
Call authorization to restrict access to certain voice terminals or gateways, or to restrict access based
on time-of-day criteria
Chapter 1 Cisco Analog Telephone Adaptor Overview
Bandwidth management for the H.323 system that will enable the gateway to restrict access when
requested bandwidth is unavailable
Call management including maintaining a list of active calls to indicate available and unavailable
voice terminals and gateways
H.323 MCUs
MCUs are endpoints in an H.323 network that support point-to-multipoint conferences and consist of a multipoint controller and at least one multipoint processor responsible for receiving voice, video, and data streams. These streams are distributed to access points participating in a point-to-multipoint conference.
H.323 Proxy Server
An H.323 proxy server is a proxy specifically designed for the H.323 protocol and examines packets between two communicating applications. Proxies can determine the destination of a call and perform call-connection steps, if necessary.
H.323 proxies perform the following key functions:
Allow voice terminals that do not support Resource Reservation Protocol (RSVP) to connect to the
proxy through remote access or local area networks with relatively reliable quality of service (QoS). Pairs of proxies can then be employed to develop tunnels across the IP network.
Support routing of H.323 traffic that is separate from ordinary data traffic by using
application-specific routing (ASR).
Enable H.323 to be deployed in networks that use private address space.
Ensure network security by configuring the proxy server to allow only H.323 traffic over the
network.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
1-4
OL-4804-01
Page 25
Chapter 1 Cisco Analog Telephone Adaptor Overview
Hardware Overview
The Cisco ATA 186 and Cisco ATA 188 are compact, easy-to-install devices. Figure 1-5 shows the rear panel of the Cisco ATA 186. Figure 1-6 shows the rear panel of the Cisco ATA 188.
Figure 1-5 Cisco ATA 186—Rear View
RJ-11 FXS ports
Figure 1-6 Cisco ATA 188—Rear View
RJ-45 10BaseT
Hardware Overview
10BaseT ACT 5VPHONE 1 PHONE 2
72210
Power connector
ACT LED
10/100 UPLINK10/100 PC LINKLINK 5VPHONE 1 PHONE 2
72211
Power
RJ-11 FXS ports
LINK LED
RJ-45 10/100BaseT ports
LINK LED
connector
The unit provides the following connectors and indicators:
5V power connector.
Two RJ-11 FXS (Foreign Exchange Station) ports—The Cisco ATA supports two independent
RJ-11 telephone ports that can connect to any standard analog telephone device. Each port supports either voice calls or fax sessions, and both ports can be used simultaneously.
Note The Cisco ATA186-I1 and Cisco ATA188-I1 provide 600-ohm resistive impedance. The
Cisco ATA 186-I2 and Cisco ATA188-I2 provide 270 ohm + 750 ohm // 150-nF complex impedance. The impedance option is requested when you place your order and should match your specific application. If you are not sure of the applicable configuration, check your country or regional telephone impedance requirements.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
1-5
Page 26
Hardware Overview
Note The Cisco ATA 188 performs auto-negotiation for duplexity and speed and is capable of 10/100 Mbps,
Chapter 1 Cisco Analog Telephone Adaptor Overview
Ethernet ports
The Cisco ATA 186 has one RJ-45 10BASE-T uplink Ethernet port to connect the Cisco ATA 186 to a 10/100BASE-T hub or another Ethernet device.
The Cisco ATA 188 has two Ethernet ports: an RJ-45 10/100BASE-T uplink port to connect the Cisco ATA 188 to a 10/100BASE-T hub or another Ethernet device and an RJ-45 10/100BASE-T data port to connect an Ethernet-capable device, such as a computer, to the network.
full-duplex operation. The Cisco ATA 186 is fixed at 10 Mbps, half-duplex operation.
The Cisco ATA 188 RJ-45 LED shows network link and activity. The LED blinks twice when the
Cisco ATA is first powered on, then turns off if there is no link or activity. The LED blinks to show network activity and is solid when there is a link.
The Cisco ATA 186 RJ-45 LED is solid when the Cisco ATA is powered on and blinks to show
network activity.
Function button—The function button is located on the top panel of the unit (see Figure 1-7).
Figure 1-7 Function Button
Function
button
CISCO ATA 186
ANALOG TELEPHONE ADAPTOR
72214
The function button lights when you pick up the handset of a telephone attached to the Cisco ATA. The button blinks quickly when the Cisco ATA is upgrading its configuration.
Note If the function button blinks slowly, the Cisco ATA cannot find the DHCP server. Check your
Ethernet connections and make sure the DHCP server is available.
Pressing the function button allows you to access to the voice configuration menu. For additional information about the voice configuration menu, see the “Voice Configuration Menu” section on
page 3-20.
Caution Never press the function button during an upgrade process. Doing so may interfere with the process.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
1-6
OL-4804-01
Page 27
Chapter 1 Cisco Analog Telephone Adaptor Overview
Software Features
The Cisco ATA supports the following protocols, services and methods:
Voice Codecs Supported, page 1-7
Additional Supported Signaling Protocols, page 1-7
Other Supported Protocols, page 1-7
Cisco ATA H.323 Services, page 1-8
Fax Services, page 1-9
Supplementary Services, page 1-9
Voice Codecs Supported
The Cisco ATA supports the following voice codecs (check your other network devices for the codecs they support):
G.711µ-law
G.711A-law
Software Features
G.723.1
G.729
G.729A
G.729B
G.729AB
Additional Supported Signaling Protocols
In addition to H.323, the Cisco ATA supports the following signaling protocols:
Session Initiation Protocol (SIP)
Skinny Client Control Protocol (SCCP)
Media Gateway Control Protocol (MGCP)
If you wish to perform a cross-protocol upgrade from H.323 to another signaling image, see the
“Upgrading the Signaling Image from a TFTP Server” section on page 8-1.
Other Supported Protocols
Other protocols that the Cisco ATA supports include the following:
802.1Q VLAN tagging
Cisco Discovery Protocol (CDP)
Domain Name System (DNS)
Dynamic Host Configuration Protocol (DHCP)
Internet Control Message Protocol (ICMP)
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
1-7
Page 28
Software Features
Internet Protocol (IP)
Real-Time Transport Protocol (RTP)
Transmission Control Protocol (TCP)
Trivial File Transfer Protocol (TFTP)
User Datagram Protocol (UDP)
Cisco ATA H.323 Services
For a list of required H.323 parameters as well as descriptions of all supported Cisco ATA H.323 services and cross references to the parameters for configuring these services, see Chapter 4, “Basic and
Additional H.323 Services.”
These services include the following features:
Supports direct IP dialing to and from a Cisco ATA without using an H.323 gatekeeper
Supports direct IP dialing in addition to proxy-routed calls to and from either phone
Uses the same configurable MediaPort to transmit and receive RTP audio
Chapter 1 Cisco Analog Telephone Adaptor Overview
Uses UDP only for H.323 RAS message transmission
Uses a TCP connection for H.225/Q.931 signaling (such as call setup, call proceeding, alerting, and
call connect)
IP address assignment—DHCP-provided or statically configured
Cisco ATA configuration by means of a TFTP server, web browser, or voice configuration menu.
VLAN configuration
Cisco Discovery Protocol (CDP)
Low-bit-rate codec selection
User authentication
Configurable tones (dial tone, busy tone, alert tone, reorder tone, call waiting tone)
Dial plans
User-configurable, call-waiting, permanent default setting
Silence suppression and comfort noise generation for G.711, G.723.1 (G.723.1 Annex A), and
G.,729 (G.729 Annex B)
Caller ID format
Ring cadence format
Hook-flash detection timing configuration
Type of Service (ToS) configuration for audio and signaling ethernet packets
Hotline and warmline support (private line automatic ringdown)
Debugging and diagnostic tools
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
1-8
OL-4804-01
Page 29
Chapter 1 Cisco Analog Telephone Adaptor Overview
Fax Services
The Cisco ATA supports two modes of fax services, in which fax signals are transmitted using the G.711 codec:
Fax pass-through mode—Receiver-side Called Station Identification (CED) tone detection with
automatic G.711A-law or G.711µ-law switching.
Fax mode—The Cisco ATA is configured as a G.711-only device.
How you set Cisco ATA fax parameters depends on what network gateways are being used. You may need to modify the default fax parameter values (see Chapter 7, “Configuring and Debugging Fax
Services”).
Note Success of fax transmission depends on network conditions and fax modem response to these conditions.
The network must have reasonably low network jitter, network delay, and packet loss rate.
Supplementary Services
Installation and Configuration Overview
H.323 supplementary services are services that you can use to enhance your telephone service. For information on how to enable and subscribe to these services, see the “CallFeatures” section on
page 5-27 and the “PaidFeatures” section on page 5-28.
For information on how to use these services, see Appendix A, “Using H.323 Supplementary Services.”
The following list contains the H.323 supplementary services that the Cisco ATA supports:
Caller ID
Calling line ID presentation/rejection (CLIP/CLIR)
Call waiting
Call waiting Caller ID
Three-way calling
Installation and Configuration Overview
Table 1-1 provides the basic steps required to install and configure the Cisco ATA to make it operational.
Table 1-1 Overview of the Steps Required to Install and Configure the Cisco ATA and Make it Operational
Action Reference
1. Plan the network and Cisco ATA configuration.
2. Install the Ethernet connection.
3. Install and configure the other network devices.
4. Install the Cisco ATA but do not power up the Cisco ATA yet. What the Cisco ATA Package Includes, page 2-2
5. Download the desired Cisco ATA release software zip file from
the Cisco web site, then configure the Cisco ATA.
Chapter 3, “Configuring the Cisco ATA for H.323”
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
1-9
Page 30
Installation and Configuration Overview
Action Reference
6. Power up the Cisco ATA.
7. Periodically, you can upgrade the Cisco ATA to a new
signaling image by using the TFTP server-upgrade method or the manual-upgrade method.
Chapter 8, “Upgrading the Cisco ATA Signaling Image”
Chapter 1 Cisco Analog Telephone Adaptor Overview
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
1-10
OL-4804-01
Page 31
CHAPTER
2
Installing the Cisco ATA
This section provides instructions for installing the Cisco ATA 186 and Cisco ATA 188. Before you perform the installation, be sure you have met the following prerequisites:
Planned the network and Cisco ATA configuration.
Installed the Ethernet connection.
Installed and configured the other network devices.
This section contains the following topics:
Safety Recommendations, page 2-1
What the Cisco ATA Package Includes, page 2-2
What You Need, page 2-2
Installation Procedure, page 2-3
Power-Down Procedure, page 2-5
Note The term Cisco ATA is used throughout this manual to refer to both the Cisco ATA 186 and the
Cisco ATA 188, unless differences between the Cisco ATA 186 and Cisco ATA 188 are explicitly stated.
Safety Recommendations
To ensure general safety, follow these guidelines:
Do not get this product wet or pour liquids into this device.
Do not open or disassemble this product.
Do not perform any action that creates a potential hazard to people or makes the equipment unsafe.
Use only the power supply that comes with the Cisco ATA.
Warning
Warning
Ultimate disposal of this product should be handled according to all national laws and regulations.
Read the installation instructions before you connect the system to its power source.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
2-1
Page 32
What the Cisco ATA Package Includes
Chapter 2 Installing the Cisco ATA
Warning
Warning
Warning
The plug-socket combination must be accessible at all times because it serves as the main disconnecting device.
Do not work on the system or connect or disconnect cables during periods of lightning activity.
This equipment contains a ring signal generator (ringer), which is a source of hazardous voltage. Do not touch the RJ-11 (phone) port wires (conductors), the conductors of a cable connected to the RJ-11 port, or the associated circuit-board when the ringer is active. The ringer is activated by an incoming call.
For translated warnings, see the Regulatory Compliance and Safety Information for the Cisco ATA 186 and Cisco ATA 188 manual.
What the Cisco ATA Package Includes
The Cisco ATA package contains the following items:
Cisco ATA 186 or Cisco ATA 188 Analog Telephone Adaptor
Read Me First - ATA Boot Load Information
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor at a Glance
Regulatory Compliance and Safety Information for the Cisco ATA 186 and Cisco ATA 188
5V power adaptor
Power cord
Note The Cisco ATA is intended for use only with the 5V DC power adaptor that comes with the unit.
What You Need
You also need the following items:
Category-3 10BASE-T or 100BASE-T or better Ethernet cable. One cable is needed for each
Ethernet connection.
A Category-3 Ethernet cable supports 10BASE-T for up to 100 meters without quality degradation, and a Category-3 Ethernet cable supports 100BASE-T for up to 10 meters without quality degradation.
For uplink connections, use a crossover Ethernet cable to connect the Cisco ATA to another Ethernet device (such as a router or PC) without using a hub. Otherwise, use straight-through Ethernet cables for both uplink and data port connections.
Access to an IP network
One or two analog Touch-Tone telephones or fax machines, or one of each
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
2-2
OL-4804-01
Page 33
Chapter 2 Installing the Cisco ATA
Installation Procedure
After the equipment is in place, see Figure 2-1 (for Cisco ATA 186) or Figure 2-2 (for Cisco ATA 188) and follow the next procedure to install the Cisco ATA.
Figure 2-1 Cisco ATA 186 Rear Panel Connections
Installation Procedure
10BaseT ACT 5VPHONE 1 PHONE 2
72212
Power outlet
IP network
Analog telephones
(or fax)
5V power
adaptor
Power cord
Figure 2-2 Cisco ATA 188 Rear Panel Connections
10/100 UPLINK10/100 PC LINKLINK 5VPHONE 1 PHONE 2
72213
Power outlet
Analog telephones
(or fax)
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
PC
IP network
5V power
adaptor
Power cord
2-3
Page 34
Installation Procedure
Step 1 Place the Cisco ATA near an electrical power outlet. Step 2 Connect one end of a telephone line cord to the Phone 1 input on the rear panel of the Cisco ATA.
Chapter 2 Installing the Cisco ATA
Procedure
Connect the other end to an analog telephone set.
If you are connecting a telephone set that was previously connected to an active telephone line, unplug the telephone line cord from the wall jack and plug it into the Phone 1 input.
Warning
Caution Do not connect the Phone input ports to a telephone wall jack. To avoid damaging the Cisco ATA or
To reduce the risk of fire, use only No. 26 AWG or larger telecommunication line cord.
telephone wiring in the building, do not connect the Cisco ATA to the telecommunications network. Connect the Phone port to a telephone only, never to a telephone wall jack.
Note The telephone must be switched to tone setting (not pulse) for the Cisco ATA to operate properly.
Step 3 (Optional) Connect the telephone line cord of a second telephone to the Phone 2 input port.
If you are connecting only one telephone to the Cisco ATA, you must use the Phone 1 input port.
Step 4 Connect an Ethernet cable to the uplink RJ-45 connector on the Cisco ATA. For the Cisco ATA 186,
this is the 10BASE-T connector; for the Cisco ATA 188, this is the 10/100UPLINK connector.
Use a crossover Ethernet cable to connect the Cisco ATA to another Ethernet device (such as a router or PC) without using a hub. Otherwise, use a straight-through Ethernet cable.
Step 5 (Cisco ATA 188 only—optional) Connect a straight-through Ethernet cable from your PC to the 10/100
PC RJ-45 connector on the Cisco ATA.
Step 6 Connect the socket end of the power cord to the Cisco-supplied 5V DC power adaptor. Step 7 Insert the power adaptor cable into the power connector on the Cisco ATA.
Caution Use only the Cisco-supplied power adaptor.
Warning
This product relies on the building’s installation for short-circuit (overcurrent) protection. Ensure that a fuse or circuit breaker no larger than 120 VAC, 15A U.S. (240VAC, 10A international) is used on the phase conductors (all current-carrying conductors).
Step 8 Connect the plug end of the 5V DC power adaptor cord into an electrical power outlet.
When the Cisco ATA is properly connected and powered up, the green activity LED flashes to indicate network activity. This LED is labeled ACT on the rear panel of the Cisco ATA 186 and is labeled LINK on the rear panel of the Cisco ATA 188.
Caution Do not cover or block the air vents on either the top or the bottom surface of the Cisco ATA. Overheating
can cause permanent damage to the unit.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
2-4
OL-4804-01
Page 35
Chapter 2 Installing the Cisco ATA
For more information about LEDs and the function button, see the “Hardware Overview” section on
page 1-5.
Power-Down Procedure
Caution If you need to power down Cisco ATA 186 or Cisco 188 at any time, use the following power-down
procedure to prevent damage to the unit.
Procedure
Step 1 Unplug the RJ45 Ethernet cable Step 2 Wait for 20 seconds. Step 3 Unplug the power cable.
Power-Down Procedure
Warning
This equipment contains a ring signal generator (ringer), which is a source of hazardous voltage. Do not touch the RJ-11 (phone) port wires (conductors), the conductors of a cable connected to the RJ-11 port, or the associated circuit-board when the ringer is active. The ringer is activated by an incoming call.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
2-5
Page 36
Power-Down Procedure
Chapter 2 Installing the Cisco ATA
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
2-6
OL-4804-01
Page 37
CHAPTER
3
Configuring the Cisco ATA for H.323
This section describes how to configure the Cisco ATA to operate with the H.323 signaling image and how the Cisco ATA obtains the latest signaling image.
You can configure the Cisco ATA for use with H.323 with any of the following methods:
By using a TFTP server—This is the Cisco-recommended method for deploying a large number of
Cisco ATAs. This method allows you to set up a unique Cisco ATA configuration file or a configuration file that is common to all Cisco ATAs. The Cisco ATA can automatically download its latest configuration file from the TFTP server when the Cisco ATA powers up, is refreshed or reset, or when the specified TFTP query interval expires.
By using manual configuration:
Voice configuration menu—This is the method you must use if the process of establishing IP connectivity for the Cisco ATA requires changing the default network configuration settings. These settings are CDP, VLAN, and DHCP. You also can use the voice configuration menu to review all IP connectivity settings. The voice configuration menu can also be used when Web access is not available.
Web-based configuration—This method is convenient if you plan to deploy a small number of Cisco ATAs in your network. To use this method, the Cisco ATA must first obtain IP connectivity, either through the use of a DHCP server or by using the voice configuration menu to statically configure IP addresses.
This section contains the following topics:
Default Boot Load Behavior, page 3-2—This section describes the process that the Cisco ATA
follows by default when it boots up. It is very important to understand this process because, if your network environment is not set up to follow this default behavior, you need to make the applicable configuration changes. For example, by default, the Cisco ATA attempts to contact a DHCP server for the necessary IP addresses to achieve network connectivity. However, if your network does not use a DHCP server, you must manually configure various IP settings as described in this section.
Specifying a Preconfigured VLAN ID or Disabling VLAN IP Encapsulation, page 3-3—This section
includes a table of the parameters you can configure for VLAN and CDP settings.
Steps Needed to Configure the Cisco ATA, page 3-5—This section provides tables that summarize
the general configuration steps you must follow to configure the Cisco ATA.
Configuring the Cisco ATA Using a TFTP Server, page 3-8—This section describes procedures for
configuring the Cisco ATA by using a TFTP server, which is the recommended configuration method for the deployment of a large number of Cisco ATAs.
Voice Configuration Menu, page 3-20—This section includes information on how to obtain basic
network connectivity for the Cisco ATA and how to perform a factory reset if necessary.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-1
Page 38
Default Boot Load Behavior
Note The term Cisco ATA is used throughout this manual to refer to both the Cisco ATA 186 and the
Cisco ATA 188, unless differences between the Cisco ATA 186 and Cisco ATA 188 are explicitly stated.
Chapter 3 Configuring the Cisco ATA for H.323
Cisco ATA Web Configuration Page, page 3-23—This section shows the Cisco ATA Web
configuration page and contains a procedure for how to configure Cisco ATA parameters using this interface.
Refreshing or Resetting the Cisco ATA, page 3-25—This section gives the procedure (via the Web
configuration page) for refreshing or resetting the Cisco ATA so that your most recent configuration changes take effect immediately.
Obtaining Cisco ATA Configuration File After Failed Attempt, page 3-26—This section gives the
formula for how soon the Cisco ATA attempts to fetch its configuration file from the TFTP server after a failed attempt.
Upgrading the H.323 Signaling Image, page 3-26—This section provides references to the various
means of upgrading your Cisco ATA signaling image.
Default Boot Load Behavior
Before configuring the Cisco ATA, you need to know how the default Cisco ATA boot load process works. Once you understand this process, you will be able to configure the Cisco ATA by following the instructions provided in this section and in the sections that follow.
All Cisco ATAs are shipped with a bootload signaling-protocol image. However, because this image is not a fully functional signaling image, the image must be upgraded. The image is designed to be automatically upgraded by a properly configured TFTP server. To configure the Cisco ATA to automatically upgrade to the latest signaling image, see the “Upgrading the Signaling Image from a
TFTP Server” section on page 8-1.
In addition, the Cisco ATA obtains its configuration file during the bootload process.
The following list summarizes the default Cisco ATA behavior during its boot-up process:
1. The Cisco ATA uses the Cisco Discovery Protocol (CDP) to discover which VLAN to enter. If the
Cisco ATA receives a VLAN ID response from the network switch, the Cisco ATA enters that VLAN and adds 802.1Q VLAN tags to its IP packets. If the Cisco ATA does not receive a response with a VLAN ID from the network switch, then the Cisco ATA assumes it is not operating in a VLAN environment and does not perform VLAN tagging on its packets.
Note If your network environment is not set up to handle this default behavior, make the necessary
configuration changes by referring to the “Specifying a Preconfigured VLAN ID or Disabling
VLAN IP Encapsulation” section on page 3-3.
2. The Cisco ATA contacts the DHCP server to request its own IP address.
Note If your network environment does not contain a DHCP server, you need to statically configure
various IP addresses so that the Cisco ATA can obtain network connectivity. For a list of parameters that you must configure to obtain network connectivity, see Table 3-6 on page 3-21. For instructions on how to use the voice configuration menu, which you must use to perform this configuration, see the “Voice Configuration Menu” section on page 3-20.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-2
OL-4804-01
Page 39
Chapter 3 Configuring the Cisco ATA for H.323
3. Also from the DHCP server, the Cisco ATA requests the IP address of the TFTP server.
4. The Cisco ATA contacts the TFTP server and downloads the Cisco ATA release software that
contains the correct signaling image for the Cisco ATA to function properly.
Note If you are not using a TFTP server, you need to manually upgrade the Cisco ATA to the correct
signaling image. For information on this procedure, see the “Upgrading the Signaling Image
Manually” section on page 8-2.
5. The Cisco ATA looks for a Cisco ATA-specific configuration file (designated by the MAC address
of the Cisco ATA and named ata<macaddress> with a possible file extension) on the TFTP server and downloads this file if it exists. For information about configuration file names, see the
“Configuration Files that the cfgfmt Tool Creates” section on page 3-13.
6. If the Cisco ATA does not find an ata<macaddress> configuration file, it looks for an atadefault.cfg
configuration file and downloads this file if it exists. This file can contain default values for the Cisco ATA to use.
Note When the Cisco ATA is downloading its DHCP configuration, the function button on the top panel
blinks.
Specifying a Preconfigured VLAN ID or Disabling VLAN IP Encapsulation
Specifying a Preconfigured VLAN ID or Disabling VLAN IP Encapsulation
If you want the Cisco ATA to use a preconfigured VLAN ID instead of using the Cisco Discovery Protocol to locate a VLAN, or if you want to disable VLAN IP encapsulation, refer to Tabl e 3 - 1 for a reference to the parameters and bits you may need to configure. Use the voice configuration menu to configure these parameters. (See the “Voice Configuration Menu” section on page 3-20 for instructions on using this menu.) Also, refer to Tab l e 3-2 for a matrix that indicates which VLAN-related parameters and bits to configure depending on your network environment.
Note Bits are numbered from right to left, starting with bit 0.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-3
Page 40
Specifying a Preconfigured VLAN ID or Disabling VLAN IP Encapsulation
Table 3-1 Parameters and Bits for Preconfiguring a VLAN ID
Parameter and Bits Reference
OpFlags:
Bit 4—Enable the use of user-specified voice VLAN ID.
Bit 5—Disable VLAN encapsulation
Bit 6—Disable CDP discovery.
VLANSetting:
Bits 0-2—Specify VLAN CoS bit value (802.1P priority) for TCP
packets.
Bits 3-5—Specify VLAN CoS bit value (802.1P priority) for
Voice IP packets
Bits 18-29—User-specified 802.1Q VLAN ID
Table 3-2 VLAN-Related Features and Corresponding Configuration Parameters
Chapter 3 Configuring the Cisco ATA for H.323
OpFlags, page 5-34
VLANSetting, page 5-12
VLANSetting
OpFlags Bit 4 OpFlags Bit 5 OpFlags Bit 6
Bits 18-29
Feature
Static VLAN101VLAN ID
CDP-acquired
000N/A
VLAN
No VLAN N/A 1 N/A N/A
No CDP N/A N/A 1 N/A
No CDP and no
011N/A
VLAN
N/A indicates that the variable is not applicable to the feature and the setting of this varaible does not affect the feature.
Example
The following procedure shows you how to configure the OpFlags and VLANSetting parameters to allow the Cisco ATA to use a user-specified VLAN ID. In this example, the voice VLAN ID is 115 (in decimal format).
Step 1 Set bits 4-6 of the OpFlags parameter to 1, 0, and 1, respectively. This setting translates to the following
bitmap:
xxxx xxxx xxxx xxxx xxxx xxxx x101 xxxx
The remaining bits of the OpFlags parameter, using all default values, make up the following bitmap representation:
0000 0000 0000 0000 0000 0000 0xxx 0010
Therefore, the resulting value of the OpFlags parameter becomes the following bitmap representation:
0000 0000 0000 0000 0000 0000 0101 0010
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-4
OL-4804-01
Page 41
Chapter 3 Configuring the Cisco ATA for H.323
In hexadecimal format, this value is 0x00000052.
Step 2 Set bits 18-29 of the VLANSetting parameter to to voice VLAN ID 115. This setting translates to the
following bitmap
xx00 0001 1100 11xx xxxx xxxx xxxx xxxx
where 000001110011 is the binary representation of the demical value 115.
The remaining bits of the VLANSetting parameter, using all default values, make up the following representation:
00xx xxxx xxxx xx00 0000 0000 0010 1011
Therefore, the resulting value of the VLANSetting parameter becomes the following bitmap representation:
0000 0001 1100 1100 0000 0000 0010 1011
In hexadecimal format, this value is 0x01cc002b.
Note If you are using the voice configuration menu to set the parameters, you must convert hexadecimal
values to decimal values. For example, the OpFlags setting of 0x00000052 is equivalent to 82 in decimal format, and the VLANSetting of 0x01cc002b is equivalent to 30146603 in decimal format.
Steps Needed to Configure the Cisco ATA
Steps Needed to Configure the Cisco ATA
This section contains the following topics:
Basic Configuration Steps in a TFTP Server Environment, page 3-5
Basic Configuration Steps in a Non-TFTP Server Environment, page 3-7
Basic Configuration Steps in a TFTP Server Environment
Table 3-3 shows the basic steps for configuring the Cisco ATA and making it operational in a typical
H.323 environment, which includes a TFTP server.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-5
Page 42
Steps Needed to Configure the Cisco ATA
Table 3-3 Basic Steps to Configure the Cisco ATA in a TFTP Environment
Action Reference
1. Download the desired Cisco ATA release software zip file from
the Cisco web site and store it on the TFTP server.
2. Follow these basic steps to create a unique Cisco ATA
configuration file, which actually entails creating two files:
a. Create a Cisco ATA configuration text file that contains
parameters that are common to all Cisco ATAs in your network.
b. Create a unique Cisco ATA configuration text file that
contains parameters that are specific to a Cisco ATA.
Make sure to use an include command in the unique configuration file to pull in values from the common configuration file.
c. Convert the unique configuration file to binary format.
Setting Up the TFTP Server with Cisco ATA Software, page 3-8
Creating Unique and Common Cisco ATA Configuration Files, page 3-9
Chapter 3 Configuring the Cisco ATA for H.323
d. Place the unique binary configuration file on the TFTP
server.
3. Optionally, create a default configuration file called
atadefault.cfg, which the Cisco ATA will download from the TFTP server only if the unique Cisco ATA file called ata<macaddress> (with a possible file extension) does not exist on the TFTP server. For information about possible configuration file names, see the “Configuration Files that the cfgfmt Tool
Creates” section on page 3-13.
4. Configure the upgradecode parameter so that the Cisco ATA will
obtain the correct signaling image from the TFTP server when the Cisco ATA powers up.
5. Configure the desired interval for the Cisco ATA to contact the
TFTP server to check for a configuration-file update or an upgrade of the signaling image file.
6. Configure the method with which the Cisco ATA will locate the
TFTP server at boot up time.
7. Power up the Cisco ATA.
8. If you make configuration changes to the Cisco ATA or upgrade
the signaling image on the TFTP server, you can refresh the Cisco ATA so that these changes take effect immediately. Otherwise, these changes will take effect when the specified interval (CfgInterval parameter value) for the TFTP query expires.
atadefault.cfg Configuration File, page 3-17
Upgrading the Signaling Image from a TFTP Server, page 8-1
Configuring the Cisco ATA Refresh Interval, page 4-9
Configuring the Cisco ATA to Obtain its Configuration File from the TFTP Server, page 3-18
Refreshing or Resetting the Cisco ATA, page 3-25
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-6
OL-4804-01
Page 43
Chapter 3 Configuring the Cisco ATA for H.323
Steps Needed to Configure the Cisco ATA
Basic Configuration Steps in a Non-TFTP Server Environment
Table 3-4 shows the basic steps for configuring the Cisco ATA without using the TFTP server method.
Table 3-4 Basic Steps to Configure the Cisco ATA Without Using the TFTP Server Method
Action Reference
1. Download the desired Cisco ATA release software zip file from the Cisco web site: a. If you are a registered CCO user. go to the following URL:
http://www.cisco.com/cgi-bin/tablebuild.pl/ata186
b. Download the zip file that contains the software for the applicable release and signaling
image you are using. The contents of each file are described next to the file name.
c. Extract the files to the desired location on your PC.
Note The file that contains the protocol signaling image has an extension of .zup.
2. Manually upgrade the Cisco ATA to the correct signaling image. Upgrading the Signaling
Image Manually, page 8-2
3. Configure the Cisco ATA by using either one of the manual-configuration methods. Voice Configuration
Menu, page 3-20
4. Power up the Cisco ATA.
Cisco ATA Web
Configuration Page, page 3-23
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-7
Page 44
Chapter 3 Configuring the Cisco ATA for H.323
Configuring the Cisco ATA Using a TFTP Server
Configuring the Cisco ATA Using a TFTP Server
The TFTP method of configuration is useful when you have many Cisco ATA because you can use a TFTP server for remote, batch configuration of Cisco ATAs. A TFTP server can host one unique configuration file for each Cisco ATA.
This section contains the following topics:
Setting Up the TFTP Server with Cisco ATA Software, page 3-8
Configurable Features and Related Parameters, page 3-8
Creating Unique and Common Cisco ATA Configuration Files, page 3-9
atadefault.cfg Configuration File, page 3-17
Configuring the Cisco ATA to Obtain its Configuration File from the TFTP Server, page 3-18
Setting Up the TFTP Server with Cisco ATA Software
This section provides the procedure for the Cisco ATA administrator to obtain the correct Cisco ATA software and set up the TFTP server with this software.
Procedure
Step 1 If you are a registered CCO user. go to the following URL:
http://www.cisco.com/cgi-bin/tablebuild.pl/ata186
Step 2 Download the zip file that contains the software for the applicable release and signaling image you are
using. The contents of each file are described next to the file name. Save the zip file onto a floppy disc.
Note The file that contains the protocol signaling image has an extension of .zup.
Step 3 Extract the signaling files onto the TFTP server. This should be the same TFTP server that will contain
the binary Cisco ATA configuration file that you create (either ata<macaddress> with a possible file extension or atadefault.cfg). For information about possible configuration file names, see the
“Configuration Files that the cfgfmt Tool Creates” section on page 3-13.
Configurable Features and Related Parameters
Table 4-1 on page 4-2 contains a list of all required H.323 parameters. These parameters must be
properly configured for the Cisco ATA to work.
For descriptions of important Cisco ATA H.323 services that you can configure, and references to their configuration parameters, see the “Important Basic H.323 Services” section on page 4-1 and the
“Additional H.323 Services” section on page 4-7.
Table 4-4 on page 4-12 lists, in alphabetical order, various features that you can configure for the
Cisco ATA. Table 4-4 on page 4-12 also includes links to the related parameter that allows you to configure each of these features. Each link takes you to a detailed description of the parameter that includes its default values.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-8
OL-4804-01
Page 45
Chapter 3 Configuring the Cisco ATA for H.323
Configuring the Cisco ATA Using a TFTP Server
For an example of how to configure parameters for the TFTP Server configuration method, see the
“Creating Unique and Common Cisco ATA Configuration Files” section on page 3-9.
Creating Unique and Common Cisco ATA Configuration Files
If you have many Cisco ATAs to configure, a good approach is to create two configuration files:
One file that will contain only parameter values unique to a specific Cisco ATA.
One file for parameters that will be configured with values common to a group of Cisco ATAs. If
this file is updated, all Cisco ATA devices in this common group can obtain the new configuration data in a batch-mode environment.
The following procedure demonstrates the steps needed to create these configuration files.
Note The parameters used in this section help illustrate the process of creating a unique Cisco ATA
configuration file, and do not include all required H.323 parameters in the examples. See Chapter 4,
“Basic and Additional H.323 Services,” for complete listings and descriptions of required parameters
and additional configurable features. Also, refer back to Table 3-3 on page 3-6 for all main configuration steps.
Procedure
Step 1 Use the h323_example.txt file as a template for creating a text file of values that are common to one
group of Cisco ATAs. The h323_example.txt file is included in the software-release zip file and contains all default values. This file is shown without its annotations in the “Configuration Text File Template”
section on page 5-2.
Copy the h323_example.txt file and save it with a meaningful name, such as common.txt.
Step 2 Configure all common parameters by editing the text file as desired. For example, you might configure
the following parameters:
UseTftp:1 DHCP:1 TFtpURL:10.10.10.1
The settings in this example indicate that a group of Cisco ATAs is using the TFTP server with an IP address of 10.10.10.1 to obtain their configuration files. These Cisco ATAs will use a DHCP server to obtain their own IP addresses but not to obtain the TFTP server IP address (because the TftpURL parameter has a configured value).
Step 3 Save your changes.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-9
Page 46
Configuring the Cisco ATA Using a TFTP Server
Step 4 Use the h323_example.txt file again, this time as a template for creating a text file of values that are
specific to one Cisco ATA. For example, you might configure the following parameters:
UserID:8530709 GkorProxy:192.168.1.1
Save this file of Cisco ATA-specific parameters as:
ata<macaddress>.txt
where macaddress is the non-dotted hexadecimal version of the MAC address of the Cisco ATA you are configuring. This non-dotted hexadecimal MAC address is labeled on the bottom of most Cisco ATAs next to the word “MAC.” The file name must be exactly 15 characters long. (However, if this filename is supplied by the DHCP server, the name can be as long as 31 characters and can be any name with printable ASCII characters.)
If necessary, you can obtain the non-dotted hexadecimal MAC address by using the atapname.exe command. For information on using the atapname.exe command, see the “Using atapname.exe Tool to
Obtain MAC Address” section on page 3-11. That section includes an example of a dotted decimal MAC
address and its corresponding non-dotted hexadecimal address.
Note The ata<macaddress>.txt file should contain only those parameters whose values are different
from the file of common parameters. Parameter values in the ata<macaddress> configuration file will overwrite any manually configured values (values configured through the web or voice configuration menu) when the Cisco ATA powers up or refreshes.
Chapter 3 Configuring the Cisco ATA for H.323
Step 5 On the top line of the ata<macaddress>.txt file, add an include command to include the name of the
common-parameters file, and save the file.
include:common.txt UserID:8530709 GkorProxy:192.168.1.1
Step 6 Run the cfgfmt.exe tool, which is bundled with the Cisco ATA software, on the ata<macaddress>.txt
text file to generate the binary configuration file. If you wish to encrypt the binary file, see the “Using
Encryption With the cfgfmt Tool” section on page 3-12.
The syntax of the cfgfmt program follows:
Syntax
cfgfmt [Encryption options] -h323 -tptag.dat input-text-file output-binary-file
Encryption options are described in the “Using Encryption With the cfgfmt Tool” section on
page 3-12.
h323 (for H.323) is the protocol you are using, which you must specify so that the cfgfmt tool will include only the applicable protocol in the converted output binary file.
The ptag.dat file, provided with the Cisco ATA software version you are running, is used by cfgfmt.exe to format a text input representation of the parameter/value pairs to its output binary representation. Be sure this file resides in the same directory from which you are running the cfgfmt program.
input-text-file is the input text file representation of the Cisco ATA configuration file.
output-binary-file is the final output binary file that Cisco ATA uses as the TFTP configuration file.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-10
OL-4804-01
Page 47
Chapter 3 Configuring the Cisco ATA for H.323
Example
cfgfmt -h323 -tptag.dat ata0a141e28323c.txt ata0a141e28323c
This example is based on a Cisco ATA MAC address of 10.20.30.40.50.60, which converts to the two-digit, lower-case hexadecimal representation of each integer as 0a141e28323c.
When you convert the ata<macaddress>.txt file to a binary file, the binary file will merge the two text files to form one Cisco ATA-specific binary configuration file for your Cisco ATA.
If the same parameter is configured with different values in these two files, the value in the ata<macaddress>.txt file takes precedence over the value in the common.txt file.
Step 7 Store all binary configuration file(s) in the TFTP server root directory. For information about possible
configuration file names, see the “Configuration Files that the cfgfmt Tool Creates” section on
page 3-13.
When the Cisco ATA powers up, it will retrieve its configuration file(s) from the TFTP server.
Step 8 If you want to make configuration changes after boot up, repeat the process of creating or editing the
text files containing the desired parameters, then converting the ata<macaddress>.txt text file to the binary file(s) and storing the binary file(s) on the TFTP server. For the configuration changes to take effect immediately, refresh the Cisco ATA. (See the “Refreshing or Resetting the Cisco ATA” section on
page 3-25.)
Configuring the Cisco ATA Using a TFTP Server
After being refreshed, the Cisco ATA will download the updated ata<macaddress> configuration file(s).
Note If you do not perform a refresh procedure, the Cisco ATA will update its configuration the next
time it contacts the TFTP server, which is based on the configured value of the CfgInterval parameter.
Using atapname.exe Tool to Obtain MAC Address
This bundled tool is useful for converting the dotted decimal version of the Cisco ATA MAC address (available on the Cisco ATA Web configuration page or from the voice configuration menu code 24#) to its default Cisco ATA profile name. This name has the following format:
ataxxxxxxxxxxxx
where each xx is the two-digit, lower-case hexadecimal representation of each integer in the dotted, decimal version of the Cisco ATA MAC address. This is the name you use for the unique Cisco ATA binary configuration file.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-11
Page 48
Configuring the Cisco ATA Using a TFTP Server
The following command and output show an example of this command.
Command Example
atapname.exe 10.20.30.40.50.60
Command Output
ata0a141e28323c
Note The same functionality is available from the voice configuration menu (voice menu code 84#), which
will announce the Cisco ATA profile name.
Using Encryption With the cfgfmt Tool
The EncryptKey or EncryptKeyEx parameter can be used to encrypt binary files that are transferred over TFTP. You can change encryption keys for each Cisco ATA so that only one specific Cisco ATA can decode the information.
Chapter 3 Configuring the Cisco ATA for H.323
Cisco strongly recommends using the EncryptKeyEx parameter for encryption because this parameter provides a stronger encryption than the EncryptKey parameter that was used in Cisco ATA software releases prior to release 2.16.
You must use version 2.3 of the cfgfmt configuration-file generation tool to use the new EncryptKeyEx parameter. This tools comes bundled with Cisco ATA software version 3.0. To verify that you have version 2.3 of the cfgfmt tool type the following command:
cfgfmt
The version number of the cfgfmt tool will be returned.
You can configure the EncryptKeyEx parameter by using the Cisco ATA Web configuration page or by using the TFTP configuration method. (For more information, see the “EncryptKeyEx” section on
page 5-7.)
You can configure the EncryptKey parameter by using the Cisco ATA Web configuration page, the voice configuration menu, or by using the TFTP configuration method. (For more information, see the
“EncryptKey” section on page 5-6.)
By default, the Cisco ATA-specific ata<macaddress> configuration file(s) are not encrypted. If encryption is required, however, you must manually configure the EncryptKeyEx or EncryptKey parameter before you boot up the Cisco ATA so that the TFTP method is secure. The Cisco ATA uses the RC4 cipher algorithm for encryption.
Note Because the factory-fresh ATA cannot accept encrypted configuration files, the first unencrypted file, if
intercepted, can easily be read. (You would still have to know the data structure format in order to decode the binary information from the unencrypted file.) Therefore, the new encryption key in the unencrypted file can be compromised.
Note For security reasons, Cisco recommends that you set the UIPassword parameter (if desired) in the
configuration file and not by using one of the manual configuration methods.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-12
OL-4804-01
Page 49
Chapter 3 Configuring the Cisco ATA for H.323
This section contains the following topics:
Configuration Files that the cfgfmt Tool Creates, page 3-13
cfgfmt Tool Syntax and Examples, page 3-14
Configuration Files that the cfgfmt Tool Creates
The number of output binary configuration files that the Cisco ATA produces is dependent on two factors:
Which encryption key parameter is used—EncryptKey or EncryptKeyEx
The total size of the binary output
Table 3-5 shows the names of the binary files that can be generated. One, two or four files can be
generated.
Note <macaddress> in Tab le 3 -5 is the MAC address of the Cisco ATA.
Configuring the Cisco ATA Using a TFTP Server
Note If you are creating an atadefault configuration file, the generated binary file name will be
atadefault.cfg.x if you encrypt the text file with the EncryptKeyEx parameter; the binary file name will be atadefault.cfg if you do not use the EncryptKeyEx parameter to encrypt the text file. For information on creating an atadefault configuration file, see the “atadefault.cfg Configuration File” section on
page 3-17.
Table 3-5 Configuration Files that the Cisco ATA May Generate
Total Binary Output Size Less Than or Equal to 2,000 Bytes
Total Binary Output Size Greater Than 2,000 Bytes
Value of EncryptKeyEx Parameter
0ata<macaddress>ata<macaddress>
ata<macaddress>.ex
Non-zero ata<macaddress>
ata<macaddress>.x
ata<macaddress>
ata<macaddress>.ex
ata<macaddress>.x
ata<macaddress>.xex
Note Place all generated binary configuration files onto the TFTP server.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-13
Page 50
Configuring the Cisco ATA Using a TFTP Server
cfgfmt Tool Syntax and Examples
The syntax of the cfgfmt tool follows:
Syntax
cfgfmt [options] input output
Syntax Definitions—Options
-eRc4Passwd—This option directs the Cisco ATA to use Rc4Passwd as the key (up to eight
hexadecimal characters) to encrypt or decrypt the input text file. However, if the Cisco ATA EncryptKey parameter in the input text file is not 0, then the value of that parameter is used to encrypt the output binary file, and Rc4Passwd is ignored. The -e portion of this option means that the Cisco ATA will use the weaker encryption method.
-E—This option directs the Cisco ATA to not use the value of the EncryptKey parameter, as set in
the input text file, to encrypt the output binary configuration file.
-xRc4Passwd—This option directs the Cisco ATA to use Rc4Passwd, which must be a hexadecimal
string of as many as 64 characters, as the key to encrypt or decrypt the input text file. However, if the Cisco ATA EncryptKeyEx parameter in the input text file is not 0, then the value of that parameter is used to encrypt the output binary file, and Rc4Passwd is ignored. The -x portion of this option means that the Cisco ATA will use the stronger encryption method.
Chapter 3 Configuring the Cisco ATA for H.323
-X—This option directs the Cisco ATA to not use the value of the EncryptKeyEx parameter, as set
in the input text file, to encrypt the output binary configuration file.
-tPtag.dat—This file, provided with the Cisco ATA software version you are running, is used by the
cfgfmt tool to format a text input representation of the parameter/value pairs to its output binary representation. Be sure this file resides in the same directory from which you are running the cfgfmt program.
-sip—Specify this tag if you are using the SIP protocol so that the cfgfmt tool will include only the
SIP protocol parameters in the converted output binary file.
-h323—Specify this tag if you are using the H.323 protocol so that the cfgfmt tool will include only
the H.323 protocol parameters in the converted output binary file.
-mgcp—Specify this tag if you are using the MGCP protocol so that the cfgfmt tool will include
only the MGCP protocol parameters in the converted output binary file.
-sccp—Specify this tag if you are using the SCCP protocol so that the cfgfmt tool will include only
the SCCP protocol parameters in the converted output binary file.
-g—This tag omits sensitive parameters in an ata<macaddress> file that was created with a version
of the cfgfmt tool prior to version 2.3.
Some parameters, specified in the ptag.dat file used by the cfgfmt tool, are marked as sensitive information (these parameters could include UIPassword, UID, PWD0). These parameters are not included in the output binary file if the -g switch is specified in the cfgfmt syntax.
Syntax Definitions—Required Parameters
Input—This is the input text file representation of the Cisco ATA configuration file.
Output—This is the final output binary file that Cisco ATA uses as the TFTP configuration file.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-14
OL-4804-01
Page 51
Chapter 3 Configuring the Cisco ATA for H.323
Syntax examples
The cfgfmt.exe syntax affects how the EncryptKeyEx or EncryptKey parameters are used, as shown in the following examples. In these examples, input-text-file is the ata<macaddress>.txt file that you will convert to binary to create the ata<macaddress> configuration file(s) for the Cisco ATA; output-binary-file is that binary ata<macaddress> file, and Secret is the encryption key.
cfgfmt -h323 -tptag.dat input-text-file output-binary-file
If input-text-file sets the Cisco ATA EncryptKey parameter to 0, then output-binary-file is not encrypted. If the input-text-file sets EncryptKey to a non-zero value, then output-binary-file is encrypted with that value.
cfgfmt -X -h323 -tptag.dat input-text-file output-binary-file
This is an example of how you might perform encryption on a first-time Cisco ATA.
The -X (uppercase) option means that any value specified for the Cisco ATA EncryptKeyEx parameter in input-text-file is ignored. However, because Secret is not specified in this example, output-binary-file is not encrypted. Nevertheless, the EncryptKeyEx parameter and its value, if specified in input-file-text, will be included in output-binary-file for possible encryption at a later time. The next time the Cisco ATA fetches the configuration file from the TFTP server, the file will be encrypted with Secret.
cfgfmt -X -xSecret -h323 -tptag.dat input-text-file
output-binary-file
Configuring the Cisco ATA Using a TFTP Server
This is an example of changing the encryption key from one key to another key.
The -X (uppercase) option means that any value specified for the Cisco ATA EncryptKeyEx parameter in input-text-file is ignored and the output-binary-file is encrypted with the Secret key. However, the EncryptKeyEx parameter and its value, if specified in input-text-file, will be included in output-binary-file.
Examples of Upgrading to Stronger Encryption Key
This section contains two examples of how you would upgrade your Cisco ATA configuration to use the stronger encyrption method if the current Cisco ATA firmware version was a version earlier than version
2.16.2. Versions earlier than 2.16.2 do not support the stronger EncryptKeyEx parameter.
Example 1
In this example, the Cisco ATA has not yet been deployed, but its firmware version is earlier than 2.16.2. Therefore, the Cisco ATA will upgrade to to firmware version 3.0 to use the EncryptKeyEx parameter as its encryption key.
The Cisco ATA in this example has a MAC address of 102030405060.
Perform the following steps:
Procedure
Step 1 Create a file called ata102030405060.txt by using the applicable example.txt file provided with the
Cisco ATA software. (For example, for H.323, the example.txt file is called h323_example.txt.)
Step 2 Modify the ata102030405060.txt file with desired parameter values. The value of the EncryptKey
parameter should be 0.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-15
Page 52
Configuring the Cisco ATA Using a TFTP Server
Step 3 Set the value of the EncryptKeyEx parameter to the chosen encryption key with which you want the
output binary file to be encrypted. In the EncryptKeyEx parameter specified in the configuration file, you can also restrict the EncryptKeyEx value to apply only to the Cisco ATA with a particular MAC address. For example, if the chosen key value is 231e2a7f10bd7fe, you can specify EncryptKeyEx as:
EncryptKeyEx:231e2a7f10bd7fe/102030405060
This means that only the Cisco ATA with the MAC address 102030405060 will be allowed to apply this EncryptKeyEx value to its internal configuration.
Step 4 Update the upgradecode parameter to instruct the Cisco ATA to upgrade to firmware version 3.0 by
means of TFTP configuration. The upgradecode parameter is described in Chapter 8, “Upgrading the
Cisco ATA Signaling Image.”
Step 5 Run the cfgfmt tool as follows:
cfgfmt -g ata102030405060.txt ata102030405060
This will generate the following two binary configuration files:
ata102030405060
ata102030405060.x
ata102030405060 is unencrypted.
ata102030405060.x is encrypted with EncryptKeyEx value.
Chapter 3 Configuring the Cisco ATA for H.323
Step 6 Place these two files on the TFTP server that the Cisco ATA will contact for its configuration files.
When the Cisco ATA powers up, it will obtain its IP address from the DHCP server. If the DHCP server specifies the TFTP server address, the Cisco ATA will contact the TFTP server obtained from DHCP because the Cisco ATA is not preconfigured with a TFTP server address. The boot process is as follows:
a. The Cisco ATA downloads the configuration file ata102030405060 from the TFTP server. b. The Cisco ATA applies parameter values in the file ata102030405060 to its internal
configuration while ignoring the EncryptKeyEx parameter (because the older version of the Cisco ATA does not yet recognize the EncryptKeyEx parameter).
c. The Cisco ATA upgrades to the 3.0 firmware load. d. The Cisco ATA reboots. e. The Cisco ATA again downloads the configuration file ata102030405060.
f. The Cisco ATA applies the value of the EncryptKeyEx parameter to its internal configuration. g. The Cisco ATA reboots. h. The Cisco ATA EncryptKeyEx value is in effect, so from this point forward the Cisco ATA will
download the ata102030405060.x file at each reboot and each time the value configured in the CfgInterval parameter expires.
Note Although EncryptKeyEx is encrypted in the ata<macaddress> file, and the ata<macaddress> file
does not contain other sensitive information, Cisco recommends that for absolute security you pre-configure the Cisco ATA as described in this example for a private network. Alternatively, you should remove ata<macaddress> once EncryptKeyEx takes effect.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-16
OL-4804-01
Page 53
Chapter 3 Configuring the Cisco ATA for H.323
Example 2
In this example, a new Cisco ATA has already b een deployed (with the EncryptKey value set) with a firmware version earlier than 2.16.2. The Cisco ATA needs to be upgraded to version 2.16.2 firmware or greater to use EncryptKeyEx parameter to encrypt its configuration file.
In this scenario, you would follow the same procedure as in Example 1, except that you would need to set the EncryptKey value to the previously configured EncryptKey value. The difference is that the ata<macaddress> file is now encrypted with EncryptKey because the Cisco ATA expects the ata<macaddress> file to be encrypted with EncryptKey.The Cisco ATA can then begin using the ata<macaddress>.x file that is encrypted with the EncryptKeyEx parameter.
atadefault.cfg Configuration File
You can create a configuration file, called atadefault.cfg, that is common to all Cisco ATAs. This configuration file is applied to a Cisco ATA only if a unique configuration file (such as ata<macaddress>) does not exist for the Cisco ATA on the TFTP server during the Cisco ATA power-up procedure.
You can use the atadefault.cfg file to provide limited functionality for when you first install the Cisco ATA. For example, if your service provider provides the ethernet connection and VoIP telephony service, you may need to call customer service to activate the service. If the atadefault.cfg file is configured to provide a direct connection to the customer service center, you can simply pick up the telephone and wait to be connected without using your regular phone.
Configuring the Cisco ATA Using a TFTP Server
The following procedure illustrates how to create the Cisco ATA default configuration file, convert it to the required binary format that the Cisco ATA can read, and store it on the TFTP server so that the Cisco ATA will download it during the boot-up process:
Procedure
Step 1 Make a copy of the h323_example.txt file and rename it atadefault.txt. Step 2 Make the desired configuration changes by editing the atadefault.txt file, then save the file. Step 3 Convert the atadefault.txt file to a binary file by running the cfgfmt.exe tool, which is bundled with the
Cisco ATA software.
Note If you wish to encrypt the binary file for security reasons, see the “Using Encryption With the
cfgfmt Tool” section on page 3-12. If you encrypt the file using the EncryptKeyEx parameter,
the resulting binary file will be called atadefault.cfg.x; if not encrypted with the EncryptKeyEx parameter the resulting binary file name will be atadefault.cfg.
Step 4 Store the binary atadefault.cfg (or atadefault.cfg.x) configuration file in the TFTP server root directory.
During the boot-up process, the Cisco ATA will download this file as its configuration file unless it first finds a Cisco ATA-specific configuration file named for the MAC address of the Cisco ATA.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-17
Page 54
Chapter 3 Configuring the Cisco ATA for H.323
Configuring the Cisco ATA Using a TFTP Server
Configuring the Cisco ATA to Obtain its Configuration File from the TFTP Server
This section describes three methods for how the Cisco ATA contacts the TFTP server to obtain its configuration file:
Using a DHCP Server, page 3-18
The Cisco ATA contacts the DHCP server, which provides the IP address of the TFTP server
The Cisco ATA uses the DHCP server but the DHCP server does not know about the TFTP server
Without Using a DHCP Server, page 3-20
Using a DHCP Server
When using a DHCP server, configuration settings vary depending on whether or not the DHCP server is under the control of the Cisco ATA system administrator or the service provider. The simplest configuration is when the DHCP server is under the control of the Cisco ATA administrator, in which case the DHCP server provides the IP address of the TFTP server. Depending on who controls the DHCP server, follow the applicable configuration procedure:
Procedure if DHCP Server is Under Control of Cisco ATA Administrator, page 3-18
Procedure if DHCP Server is not Under Control of Cisco ATA Administrator, page 3-19
This section also includes the topic:
Other DHCP Options You Can Set, page 3-19
Note If no DHCP server is found and the Cisco ATA is programmed to find one, the function button
continues to blink.
Procedure if DHCP Server is Under Control of Cisco ATA Administrator
Procedure
Step 1 On the DHCP server, set one of the following two options:
DHCP option 150 (TFTP server IP address)
Standard DHCP option 66 (TFTP server name)
If you use DHCP option 150, the Cisco ATA will ignore DHCP option 66. However, if you use DHCP option 66, you must turn off DHCP option 150 or set its value to 0.
Note You can turn off the DHCP option 150 request by using the Cisco ATA OpFlags parameter (see
the “OpFlags” section on page 5-34).
Step 2 Make sure to use default values for the following Cisco ATA parameters:
TftpURL=0
UseTftp=1
DHCP=1
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-18
OL-4804-01
Page 55
Chapter 3 Configuring the Cisco ATA for H.323
This completes the parameter settings and DHCP options you need to configure for this procedure. The Cisco ATA will contact the DHCP server for the IP address of the TFTP server that contains the Cisco ATA configuration file.
Procedure if DHCP Server is not Under Control of Cisco ATA Administrator
This is the procedure to use if the DHCP server is not under the control of the Cisco ATA administrator, which means that the URL of the TFTP server must be manually configured.
Procedure
Step 1 Using the voice configuration menu, set the parameter TftpURL to the IP address or URL of the TFTP
server. For more information on setting the TftpURL parameter, see the “TftpURL” section on page 5-5. For information about using the Cisco ATA voice configuration menu, see the “Voice Configuration
Menu” section on page 3-20.
Note If you are not using a DHCP server to provide the TFTP server location, you must manually
configure the TftfURL. You can do this by using the voice configuration menu without first obtaining network connectivity for the Cisco ATA. If you want to configure this value using the Web configuration page, you first must obtain network connectivity by using the voice configuration menu to statically configure IP address information (see the “Voice Configuration
Menu” section on page 3-20).
Configuring the Cisco ATA Using a TFTP Server
Step 2 Use the default value of 1 for the Cisco ATA parameter DHCP. Step 3 Use the default value of 1 for the Cisco ATA parameter UseTftp.
This completes the parameter settings you need to configure for this procedure. The Cisco ATA will contact the manually configured TFTP server that contains the Cisco ATA configuration file.
Other DHCP Options You Can Set
The following parameters can also be configured with DHCP:
Boot file name of DHCP header—The ata<macaddress> binary Cisco ATA configuration file,
which can have a maximum of 31 characters and can be any name with printable ASCII characters
Client PC address
DHCP option 1—Client Subnet Mask
DHCP option 3—Routers on the client’s subnet
DHCP option 6—One or two Domain Name servers
DHCP option 42—One or two Network Time Protocol servers
Note DHCP options 43 and 60 are set by the Cisco ATA. Option 43 specifies the protocol and option 60
identifies the vendor class of the Cisco ATA box.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-19
Page 56
Voice Configuration Menu
Without Using a DHCP Server
Use the following procedure if you are not using a DHCP server in your environment but are still using a TFTP server to obtain the Cisco ATA configuration file:
Procedure
Step 1 Set the DHCP parameter to 0. Step 2 Set the UseTFTP parameter to 1. Step 3 Set the Cisco ATA parameter TftpURL to the IP address or URL of the TFTP server. For more
information on setting the TftpURL parameter, see the “TftpURL” section on page 5-5.
Note If you are not using a DHCP server to provide the TFTP server location, you must manually enter
the TftpUrl using either the voice configuration menu or the Web configuration page.
Step 4 If you have done already done so, statically configure the following parameters using the voice
configuration menu (see the “Voice Configuration Menu” section on page 3-20). These are the parameters you need to configure for the Cisco ATA to obtain network connectivity:
StaticIP
Chapter 3 Configuring the Cisco ATA for H.323
StaticRoute
StaticNetMask
Other parameters that are normally supplied by DHCP may be provided statically by configuring their values. These parameters are:
DNS1IP
DNS2IP
NTPIP
AltNTPIP
Domain
This completes the parameter settings you need to configure in order for the Cisco ATA to contact the TFTP server (without using DHCP) that will contain the configuration file for the Cisco ATA.
Voice Configuration Menu
The main reasons to use the voice configuration menu are to establish IP connectivity for the Cisco ATA if a DHCP server is not being used in your network environment, and to reset the Cisco ATA to its factory values if necessary. You can also use the voice configuration menu if you need to configure a small number of parameters or if the web interface and TFTP configuration are not available.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-20
OL-4804-01
Page 57
Chapter 3 Configuring the Cisco ATA for H.323
Note Do not use the voice configuration menu to attempt to change any values that you configured by means
of the TFTP configuration file method. Whenever the Cisco ATA refreshes, it downloads its ata<macaddress> configuration file or atadefault.cfg default configuration file from the TFTP server, and the values in either of these files will overwrite the values of any corresponding parameters configured with the voice configuration menu.
See Chapter 5, “Parameters and Defaults,” for a complete list of parameters and their definitions. Also see Table 4-4 on page 4-12 for an alphabetical listing of configurable features and references to their corresponding parameters.
This section contains the following topics:
Using the Voice Configuration Menu, page 3-21
Entering Alphanumeric Values, page 3-22
Resetting the Cisco ATA to Factory Default Values, page 3-23
Using the Voice Configuration Menu
Voice Configuration Menu
To manually configure the Cisco ATA by using the voice configuration menu and the telephone keypad, perform the following steps:
Procedure
Step 1 Connect an analog touch-tone phone to the port labeled Phone 1 on the back of the Cisco ATA. Step 2 Lift the handset and press the function button located on the top of the Cisco ATA. You should receive
the initial voice configuration menu voice prompt.
Step 3 Using the telephone keypad, enter the voice menu code for the parameter that you want to configure or
the command that you want to execute, then press #. For a list of voice menu codes, see Appendix B,
“Voice Menu Codes.”
Table 3-6 lists the menu options that you need to configure basic IP connectivity for the Cisco ATA, after
which you can use the Cisco ATA web configuration page to configure additional parameters.
Note If you are using the voice configuration menu to statically configure the Cisco ATA IP address,
you must disable DHCP by setting its value to 0.
Table 3-6 Parameters that Provide Basic IP Connectivity for the Cisco ATA
Voice Menu Number Features
1 StaticIP—IP address of the Cisco ATA.
2 StaticRoute—Default gateway for the Cisco ATA to use.
10 StaticNetMask—Subnet mask of the Cisco ATA.
20 DHCP—Set value to 0 to disable the use of a DHCP server; set value to 1 to enable
DHCP.
21 Review the IP address of the Cisco ATA.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-21
Page 58
Voice Configuration Menu
Step 4 Follow the voice prompts and enter the appropriate values, then press the # key.
Chapter 3 Configuring the Cisco ATA for H.323
Table 3-6 Parameters that Provide Basic IP Connectivity for the Cisco ATA (continued)
Voice Menu Number Features
22 Review the default router for the Cisco ATA to use.
23 Review subnet mask of the Cisco ATA.
Note Use the * key to indicate a delimiter (dot). For example, to enter an IP address of 192.168.3.1,
you would enter 192*168*3*1 on your telephone keypad.
Note When entering values for a field that contains a hexadecimal value, you must convert the
hexadecimal value to a decimal value in order to enter it into the voice configuration menu system. For example, to enter the hexadecimal value 0x6A, you would enter the number 106 on the telephone keypad.
The voice configuration menu repeats the value you entered, then prompts you to press one of the following keys:
1=Change your entered value
2=Review your entered value
3=Save your entered value
4=Review the current saved value
Step 5 Cisco strongly recommends that you set a password. Use the voice menu code 7387277 (SETPASS) to
configure a password through the voice configuration menu, after which you are prompted for the password whenever you attempt to change a parameter value.
Step 6 After completing the configuration through the voice configuration menu, press the # key to exit. Step 7 Hang up the telephone. The Cisco ATA configuration refreshes. The function button fast-blinks when
the refresh completes.
Entering Alphanumeric Values
Some voice configuration menu options require you to enter alphanumeric characters. Alphanumeric entry differs from numeric entry because you must press # after each character selected.
If you need to enter an alphanumeric value, the voice prompt tells you to enter an alphanumeric value; otherwise, enter a numeric value (0 to 9).
Table 3-7 lists the keys on a telephone keypad and their respective alphanumeric characters.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-22
OL-4804-01
Page 59
Chapter 3 Configuring the Cisco ATA for H.323
Using Tabl e 3 - 7 as a guide, enter the appropriate number key on the telephone keypad as many times as needed to select the number, letter, or symbol required. For example, to enter 58sQ, you would enter:
5 # 8 # 7 7 7 7 7 # 7 7 7 7 7 7 7 # #
Table 3-7 Alphanumeric Characters
Key Alphanumeric Characters
1 1 ./_\ @*space return +-!,?|~^#=$”‘’%<>[] :;{}()&
2 2 a b c A B C
33 d e f D E F
4 4 g h i G H I
5 5 j k l J K L
66 m n o M N O
77 p q r s P Q R S
88 t u v T U V
9 9 w x y z W X Y Z
00
Cisco ATA Web Configuration Page
Resetting the Cisco ATA to Factory Default Values
It is possible that you may, under some circumstances, want to reset the Cisco ATA to its factory default values. For example, this is the only way to recover a forgotten password without contacting your Cisco representative.
To perform a factory reset, you must use the voice configuration menu and follow these steps:
Procedure
Step 1 Press the function button on the Cisco ATA. Step 2 Press the digits 322873738 (FACTRESET) then press # on your telephone keypad. Step 3 Press * on your telephone keypad to confirm that you want to reset the Cisco ATA, then hang up the phone.
Cisco ATA Web Configuration Page
You can use the Cisco ATA web configuration page in a non-TFTP configuration environment, or in a TFTP configuration environment as a read-only record of individual customer parameters.
You can display the most recent Cisco ATA configuration file from the TFTP server by opening your web browser and typing the following:
http://<ipaddress>/refresh
where ipaddress is the IP address of the Cisco ATA.
Figure 3-1 shows and example of the Cisco ATA web configuration page, which displays all
configurable parameters.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-23
Page 60
Cisco ATA Web Configuration Page
Note Do not use the web configuration page to attempt to change any values that you configured by means of
the TFTP configuration file method. Whenever the Cisco ATA refreshes, it downloads its ata<macaddress> configuration file(s) or atadefault.cfg default configuration file from the TFTP server, and the values in either of these files will overwrite the values of any corresponding parameters configured with the web configuration method.
Figure 3-1 Cisco ATA Web Configuration Page
Chapter 3 Configuring the Cisco ATA for H.323
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-24
OL-4804-01
Page 61
Chapter 3 Configuring the Cisco ATA for H.323
You can access the web configuration page from any graphics-capable browser, such as Microsoft Internet Explorer or Netscape. This provides easy initial access to the Cisco ATA configuration within the administrator’s private network.
Follow these steps to set parameters using the web configuration page:
Procedure
Step 1 Make sure that your PC and the Cisco ATA are already networked and visible to each another. Step 2 Open your web browser. Step 3 Enter the URL for your configuration page. The default URL for the web server is:
http://IP Address/dev
For example, the configuration page for a Cisco ATA with the IP address 192.168.3.225 is:
http://192.168.3.225/dev
Step 4 Select the values for the items that you want to configure. See Chapter 5, “Parameters and Defaults,” for
a complete list of parameters and their definitions. Also see Table 4-4 on page 4-12 for an alphabetical listing of configurable features and references to their corresponding parameters.
Refreshing or Resetting the Cisco ATA
Note Cisco strongly recommends that you set a password. Use the UIPassword parameter to configure a
password, after which you are prompted for the password whenever you attempt to change a parameter value. Configuration parameters cannot be accessed through the voice configuration menu if the password contains one or more letters and can be changed only by using the web interface or the TFTP configuration method.
Step 5 Click apply to save your changes.
The Cisco ATA automatically refreshes its configuration.
Step 6 Close your web browser.
Refreshing or Resetting the Cisco ATA
Whenever you make configuration changes to your Cisco ATA configuration file, you can refresh or reset the Cisco ATA for these configuration changes to immediately take effect. If you do not refresh or reset the Cisco ATA, the configuration changes will take effect the next time the Cisco ATA contacts the TFTP server, which occurs based on the configured value of the CfgInterval parameter.
Note A refresh procedure will update the Cisco ATA configuration file. A reset procedure will also update the
Cisco ATA configuration file, and will additionally power-down and power-up the Cisco ATA. A reset should not be necessary if your only goal is to update the configuration file.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
3-25
Page 62
Chapter 3 Configuring the Cisco ATA for H.323
Obtaining Cisco ATA Configuration File After Failed Attempt
Procedure to Refresh the Cisco ATA
To refresh the Cisco ATA, enter the following command from your web browser:
http://<ipaddress>/refresh
where ipaddress is the IP address of the Cisco ATA that you are refreshing.
Procedure to Reset the Cisco ATA
To reset the Cisco ATA, enter the following command from your web browser:
http://<ipaddress>/reset
where ipaddress is the IP address of the Cisco ATA that you are resetting.
Obtaining Cisco ATA Configuration File After Failed Attempt
The Cisco ATA uses the following formula for determining how soon to contact the TFTP server for the Cisco ATA configuration file after a failed attempt at getting the file. The result of the formula is called the random back-off amount.
random back-off amount = CfgInterval + random(min(1800, CfgInterval))
where
CfgInterval is the value of the CfgInterval configuration parameter (in seconds). For more
information about this parameter, see the “CfgInterval” section on page 5-6.
random(x) function yields a value between 0 and x-1.
min(x,y) function yields the smaller value of x and y.
Upgrading the H.323 Signaling Image
For instructions on how to upgrade the Cisco ATA to the most recent H.323 signaling image, refer to the following list:
To use the recommended TFTP method of upgrading the Cisco ATA, see the “Upgrading the
Signaling Image from a TFTP Server” section on page 8-1.
In the rare instance that you are not using the TFTP server to configure the Cisco ATA and to obtain
software upgrades, you must manually upgrade to the latest signaling image immediately after the Cisco ATA boots up. In this case, see the “Upgrading the Signaling Image Manually” section on
page 8-2.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
3-26
OL-4804-01
Page 63
CHAPTER
4
Basic and Additional H.323 Services
This section provides information about key basic and additional H.323 services that the Cisco ATA supports:
Important Basic H.323 Services, page 4-1—This section includes a list of parameters that you must
configure in order for the Cisco ATA to function in an H.323 environment.
Additional H.323 Services, page 4-7—This section contains information about additional,
commonly used H.323 features, with references to the parameters for configuring these services.
Complete Reference Table of all Cisco ATA H.323 Services, page 4-12—This section contains a
complete listing of Cisco ATA services supported for H.323, and includes cross references to the parameters for configuring these services.
Note The term Cisco ATA refers to both the Cisco ATA 186 and the Cisco ATA 188, unless otherwise stated.
Important Basic H.323 Services
This section provides descriptions and cross references for configuring required H.323 parameters and also for configuring important H.323 services:
Required Parameters, page 4-1
Setting Up User IDs for the Cisco ATA, page 4-3
Using the Cisco ATA with an H.323 Gatekeeper, page 4-3
Using the Cisco ATA Without an H.323 Gatekeeper, page 4-6
Setting the Audio Codecs, page 4-7
Required Parameters
You need to supply values for the required H.323 parameters shown in Table 4-1. The Parameter column provides the name of the parameter and a cross reference which provides a more-detailed description of the parameter.
Note See Chapter 5, “Parameters and Defaults,” for information about additional Cisco ATA parameters.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
4-1
Page 64
Chapter 4 Basic and Additional H.323 Services
Important Basic H.323 Services
Table 4-1 Required H.323 Parameters and Defaults
Parameter Value Type Description
UID0, page 5-16 Alphanumeric
string
UID1, page 5-17 Alphanumeric
string
PWD0, page 5-16 Alphanumeric
string
PWD1, page 5-18 Alphanumeric
string
LoginID0, page 5-18 Alphanumeric
string
LoginID1, page 5-19 Alphanumeric
string
GkOrProxy, page 5-13 Alphanumeric
string
UseLoginID, page 5-19 Boolean Enables the Cisco ATA to use its H.323 ID for
AltGk, page 5-14 Alphanumeric
string
AltGkTimeOut, page 5-15 Integer The timeout value, in seconds, for an alternate
GkTimeToLive, page 5-14 Integer The “time to live” value that is used when the Cisco ATA
GkId, page 5-14 Alphanumeric
string
User ID for the Phone 1 port. 3 0
User ID for Phone 2 port. 13 0
Password for the Phone 1 port. 4 0
Password for the Phone 2 port. 14 0
Login ID for the Phone 1 port. If this value is 0, the UID0 parameter is used for authentication.
Login ID for the Phone 2 port. If this value is 0, the UID1 parameter is used for authentication.
IP address of the H.323 gatekeeper. 5 0
authenticated login.
IP address of the statically defined alternate gatekeeper. 6 0
gatekeeper. The allowed range is 30 to 4294967295 seconds.
registers with the H.323 gatekeeper. The registration is valid until the configured time expires.
Identifier for the primary H.323 gatekeeper. 91 .
Voice Menu Access Code Default
46 0
47 0
93 0
251 0
250 0
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
4-2
OL-4804-01
Page 65
Chapter 4 Basic and Additional H.323 Services
Setting Up User IDs for the Cisco ATA
Each Cisco ATA can support two FXS ports. You can assign a user ID, which is usually an E.164 phone number, to each port. Use the Cisco ATA parameter UID0 to configure an ID for the Phone 1 port, and use the UID1 parameter for the user ID of the Phone 2 port.
Related Configuration Parameters
UID0, page 5-16
UID1, page 5-17
Using the Cisco ATA with an H.323 Gatekeeper
The Cisco ATA can function with an H.323 gatekeeper to enable Cisco ATA registration, admission, and use of directory services on an H.323 network. To use the Cisco ATA with a primary H.323 gatekeeper, you need to configure the GkOrProxy parameter with the IP address assigned to the primary H.323 gatekeeper. Optionally, you can specify the primary gatekeeper identifier using the GkId parameter if this identifier is required for the Cisco ATA to successfully register with the H.323 network.
Important Basic H.323 Services
This section contains the following topics:
Choosing Cisco ATA Registration Mode with an H.323 Gatekeeper, page 4-3
Setting Up Gatekeeper Time-To-Live Value, page 4-4
Setting Up an Alternate H.323 Gatekeeper, page 4-4
Establishing Authentication with Cisco H.323 Gatekeeper, page 4-5
Related Configuration Parameters
GkOrProxy, page 5-13
GkId, page 5-14
Choosing Cisco ATA Registration Mode with an H.323 Gatekeeper
The Cisco ATA can register with an H.323 gatekeeper in one of two modes:
Single registration—Both Cisco ATA FXS ports register at the same time with the H.323
gatekeeper. This reduces gatekeeper registration traffic by 50 percent when both ports are enabled.
Dual registration—Each FXS port registers separately with the H.323 gatekeeper.
To configure single-mode registration, you need to set the UseLoginID parameter to 1, and then configure the LoginID1 and LoginID2 parameters with identical values. The LoginID1 and LoginID2 parameters are used for the H.323 ID, whereas the UID0 and UID1 parameter values are used as E.164 phone numbers.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
4-3
Page 66
Important Basic H.323 Services
If LoginID1 and LoginID2 are not used or are not set to identical values, the Cisco ATA uses dual-registration mode.
Related Parameters
LoginID0, page 5-18
LoginID1, page 5-19
UID0, page 5-16
UID1, page 5-17
Setting Up Gatekeeper Time-To-Live Value
You can specify the valid duration of the H.323 gatekeeper registration, in seconds, by using the GkTimeToLive parameter.
Related Configuration Parameter
GkTimeToLive, page 5-14
Chapter 4 Basic and Additional H.323 Services
Setting Up an Alternate H.323 Gatekeeper
To provide redundancy in systems that use an H.323 gatekeeper, the Cisco ATA allows you to either statically configure an alternate H.323 gatekeeper or dynamically assign an H.323 gatekeeper.
To enable the static alternate gatekeeper feature, you need to configure the AltGk parameter with the IP address assigned to the alternate H.323 gatekeeper. To enable the Cisco ATA to perform full gatekeeper registration when it switches to a statically configured alternate H.323 gatekeeper, configure Bit 3 of the ConnectMode parameter to the value of 1.
To enable the dynamic alternate gatekeeper feature, you need to configure the primary H.323 gatekeeper so that the list of alternate gatekeepers is included in the H.225 RAS messages that the H.323 gatekeeper sends to the Cisco ATA. The Cisco ATA can accept as many as four dynamic alternate gatekeepers configured in the H.225 RAS messages. (The Cisco ATA supports the alternate gatekeeper list in GCF/GRJ, ACF/ARJ, RCF/RRJ, and DRJ RAS messages.)
Dynamic alternate gatekeepers and static alternate gatekeepers can co-exist. When the Cisco ATA receives an alternate gatekeeper list in an H.225 RAS message, the static alternate gatekeeper is merged with the dynamic alternate gatekeepers. The static alternate gatekeeper is kept and given the lowest priority.
You can configure the AltGkTimeout parameter to specify the number of seconds the Cisco ATA should wait before it automatically switches back to the primary H.323 gatekeeper after being moved to an alternate gatekeeper. By default, the switch-back procedure is disabled (the AltGkTimeout parameter value is set to 0).
Related Configuration Parameters
AltGk, page 5-14
AltGkTimeOut, page 5-15
ConnectMode, page 5-32
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
4-4
OL-4804-01
Page 67
Chapter 4 Basic and Additional H.323 Services
Establishing Authentication with Cisco H.323 Gatekeeper
You can configure the Cisco ATA to establish authentication with a Cisco H.323 Gatekeeper. The Cisco ATA supports two authentication methods:
Cisco registration level-security
Cisco admission-level security (per-call basis)
To configure either authentication method, use the following procedure:
Procedure
Step 1 Set the UseLoginID parameter to 1. This setting indicates that the LoginID0 and LoginID1 fields will
be used for Cisco ATA H.323 registration.
Step 2 Set the UID0 and UID1 parameters to the E.164 phone numbers that are assigned to the FXS ports on
the Cisco ATA.
Step 3 Set the LoginID0 and LoginID1 parameters to the H.323 ID. The H.323 ID is used when the Cisco ATA
registers with the H.323 gatekeeper. This ID is also used as the account ID for the RADIUS server.
Step 4 Set the PWD0 and PWD1 parameters to the passwords for the Phone 1 and Phone 2 FXS ports (the
passwords in the RADIUS server), respectively.
Important Basic H.323 Services
Step 5 Set the NTPIP and AltNTPIP parameters to the IP addresses of the NTP servers in your network. Step 6 Select the authentication method using the AutMethod parameter (0 indicates no authentication; 1
indicates the Cisco registration level security method; 2 indicates the Cisco admission level security method).
Note The authentication methods are Cisco Proprietary H.235 implementations, which use the Cisco
access/clear token structure rather than the VocalTec crypto token structure.
Related Configuration Parameters
UseLoginID, page 5-19
AutMethod, page 5-20
LoginID0, page 5-18
LoginID1, page 5-19
UID0, page 5-16
UID1, page 5-17
PWD0, page 5-16
PWD1, page 5-18
NTPIP, page 5-10
AltNTPIP, page 5-11
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
4-5
Page 68
Chapter 4 Basic and Additional H.323 Services
Important Basic H.323 Services
Using the Cisco ATA Without an H.323 Gatekeeper
You can use the Cisco ATA without using an H.323 gatekeeper, as this section describes with the following topics:
Using the Cisco ATA With an H.323 Gateway but Without an H.323 Gatekeeper, page 4-6
Using Multiple Cisco ATAs Without an H.323 Gatekeeper, page 4-6
Using the Cisco ATA With an H.323 Gateway but Without an H.323 Gatekeeper
You can use a Cisco ATA with an H.323 network that does not contain an H.323 gatekeeper. In this scenario, all calls initiated from the Cisco ATA are directed to a specified H.323 gateway. To specify this H.323 gateway, you configure its IP address using the Gateway parameter, and you disable the H.323 gatekeeper feature by setting the GkorProxy parameter to 0.
Note For all calls sent from the H.323 gateway to the Cisco ATA, the E.164 number assigned to each of the
Cisco ATA FXS ports must be included in the H.225 Setup message, either in the DestinationAddress field or the Q.931 CalledPartyNumber field. The Cisco ATA will reject the call if it cannot find its E.164 number in the H.255 Setup message.
Related Configuration Parameters
Gateway, page 5-20
GkOrProxy, page 5-13
Using Multiple Cisco ATAs Without an H.323 Gatekeeper
You can make calls from one Cisco ATA to another Cisco ATA in an H.323 network that does not contain an H.323 gatekeeper.
For one Cisco ATA to access a specific FXS port on another Cisco ATA, you use an IP dialing procedure. The Cisco ATA originating the call must have the following information about the destination Cisco ATA:
E.164 phone number of the destination FXS port
IP address of the destination Cisco ATA
To enable the IP dialing procedure, you need to set the IPDialPlan parameter to 1 to instruct the Cisco ATA to look for the destination IP address in the dialed digits.
Example
Cisco ATA X is going to initiate a call to Cisco ATA Y (with the following pertinent information):
IP address of Cisco ATA Y—192.168.2.112.
E.164 phone number for the Phone 1 port of Cisco ATA Y—1:5556666
E.164 phone number for the Phone 2 port of Cisco ATA Y—2:5558888
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
4-6
OL-4804-01
Page 69
Chapter 4 Basic and Additional H.323 Services
To call the Phone 1 port on Cisco ATA Y, you would dial 5556666**192*168*2*112#.
To call the Phone 2 port on Cisco ATA Y, you would dial 5558888**192*168*2*112#.
Related Configuration Parameters
IPDialPlan, page 5-60
DialPlan, page 5-52
Setting the Audio Codecs
You can configure the following codec-related settings:
Low-bit-rate codec—When operating with a low-bit-rate codec, the Cisco ATA can support either
two G.723.1 connections or one G.729 connection. You must statically configure the selection of G.723.1 or G.729 by using the LBRCodec parameter.
When G.723.1 is the low-bit-rate codec, each FXS port is allocated one G.723.1 connection. When G.729 is used, only one FXS port can use G.729. The G.729 resource is allocated in a dynamic manner. When a call begins, the FXS port requests and takes an available G.729 resource. The Cisco ATA releases this resource when the call is completed.
Additional H.323 Services
Use Bit 1 of the AudioMode parameter to disable and enable the use of the low-bit-rate codec.
Related Configuration Parameters
LBRCodec, page 5-23
AudioMode, page 5-24
Voice codec—You can configure the preferred voice codec for transmitting and receiving voice data
by using the TxCodec and RxCodec parameters, respectively. Cisco recommends that you configure the same voice codec for TxCodec and RxCodec.
Related Configuration Parameters
TxCodec, page 5-22
RxCodec, page 5-22
Silence suppression—You can configure silence suppression for G.711/G.723.1/G.729 by using the
ConnectMode parameter (Bit 0 for the Phone 1 port and Bit 16 for the Phone 2 port).
Related Configuration Parameter
ConnectMode, page 5-32
Additional H.323 Services
This section describes additional H.323 services and, where applicable, provides configuration information and cross references to the parameters for configuring these services, described in alphabetical order:
Configurable Reboot of Cisco ATA, page 4-8
Configuring Audio Packet Settings, page 4-8
Configuring Billable Features, page 4-8
Configuring the Call Waiting Permanent Default Setting, page 4-9
Configuring the Cisco ATA Refresh Interval, page 4-9
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
4-7
Page 70
Additional H.323 Services
Chapter 4 Basic and Additional H.323 Services
Configuring Hook Flash Timing, page 4-9
Configuring the Mixing of Call Waiting Tone and Audio, page 4-9
Configuring Network Ringback Tone, page 4-10
Configuring Reverse Audio Cut-Through Behavior, page 4-10
Configuring Supplementary Service Behavior and Parameters, page 4-10
Debugging Diagnostics, page 4-10
Hardware Information Display, page 4-10
Network Timing, page 4-11
Polarity Settings, page 4-11
Progress Tones, page 4-11
Selecting DTMF and Hookflash Transmission Methods, page 4-11
Selecting H.323 Connection and H.245 Transmission Methods, page 4-12
Setting Dial Plans, page 4-12
Configurable Reboot of Cisco ATA
The Cisco ATA continuously monitors its Ethernet connection to the switch or hub. If this connection is broken, the Cisco ATA starts an internal timer that runs until a configurable timeout period expires. Once the timeout value is reached, the Cisco ATA automatically reboots. This timeout value is configured by using the FeatureTimer2 configuration parameter. For more information, see the
“FeatureTimer2” section on page 5-31.
Configuring Audio Packet Settings
Table 4-2 lists configurable audio-packet settings and their related configuration parameters.
Table 4-2 Audio Packet Settings and Related Parameters
Feature Related Parameter
Base port for receiving RTP packets MediaPort, page 5-21
Class of Service (CoS) bit specification for signaling IP packets VLANSetting, page 5-12
RTP-packet size NumTxFrames, page 5-25
Type of Service (ToS) bit specification for audio and signaling IP packets
TOS, page 5-26
Configuring Billable Features
You can customize specific features on a subscription basis by changing the values of specific bits in several different parameters. Tab le 4-3 contains a list of billable features and their related parameters:
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
4-8
OL-4804-01
Page 71
Chapter 4 Basic and Additional H.323 Services
Table 4-3 Billable Features and Related Parameters
Feature Related Parameters
Call Conferencing PaidFeatures, page 5-28, CallFeatures, page 5-27
Call Waiting PaidFeatures, page 5-28, CallFeatures, page 5-27, SigTimer, page 5-31
Caller ID PaidFeatures, page 5-28, CallFeatures, page 5-27, CallerIdMethod, page 5-38
Polarity Polarity, page 5-39
Note CallWaitCallerID is an obsolete parameter. Do not use it.
Configuring the Call Waiting Permanent Default Setting
This feature allows you to specify the default call-waiting setting for every call on a permanent basis by means of the service activation and deactivation codes.
Additional H.323 Services
Related Parameter
ConnectMode, page 5-32—Bit 23
Configuring the Cisco ATA Refresh Interval
When the value specified in the CfgInterval parameter is reached, the Cisco ATA attempts to refresh its configuration file from the TFTP server. Set the CfgInterval parameter to an interval value (in seconds) for refreshing the Cisco ATA configuration file. Cisco recommends that the interval be semi-random to prevent many simultaneous contacts with the TFTP server. For more information, see the “CfgInterval”
section on page 5-6.
When the Cisco ATA contacts the TFTP server, it also checks to see if an upgrade signaling image has been placed on the TFTP server. If such an image exists, the Cisco ATA will download this image.
Configuring Hook Flash Timing
This feature provides the ability to adjust the hook-flash timing to meet local requirements.
Related Parameter
SigTimer, page 5-31—Bits 26 and 27 are for configuring the minimum on-hook time required for a hook
flash event, and bits 28 through 31 are for configuring maximum on-hook time.
Configuring the Mixing of Call Waiting Tone and Audio
This feature allows the call-waiting tone to be mixed with the audio in an active call. This mixing causes the call-waiting tone to sound without a pause in the audio.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
4-9
Page 72
Additional H.323 Services
Related Parameter
ConnectMode, page 5-32
Configuring Network Ringback Tone
You can configure the Cisco ATA to send a ringback tone to a caller by using bit 19 of the ConnectMode parameter.
Related Configuration Parameter
ConnectMode, page 5-32
Configuring Reverse Audio Cut-Through Behavior
You can configure the reverse audio cut-through behavior of the Cisco ATA by using Bit 5 of the ConnectMode parameter.
Related Configuration Parameter
ConnectMode, page 5-32
Chapter 4 Basic and Additional H.323 Services
Configuring Supplementary Service Behavior and Parameters
Service providers can offer many supplementary services, which can be activated, configured, or deactivated in more than one way.
The behavior and activation/deactivation of call supplementary services can be different from one country to another. You can use the CallCmd parameter to define the behavior and the activation/deactivation access code for the supplementary services that the Cisco ATA supports.
Related Configuration Parameter
CallCmd, page 5-29
Debugging Diagnostics
You can use the following parameter to troubleshoot operation issues:
NPrintf, page 5-61—Use this parameter to specify the IP address and port where debug information
is sent.
Hardware Information Display
Cisco ATA hardware information is displayed in the lower-left corner of the Cisco ATA Web configuration page.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
4-10
OL-4804-01
Page 73
Chapter 4 Basic and Additional H.323 Services
Network Timing
You can fine-tune your network timing with the following parameters:
TimeZone, page 5-36—Use for time-stamping incoming calls (offset from Greenwich Mean Time)
with local time.
NTPIP, page 5-10—Use for configuring the IP address of the Network Time Protocol server. NTP
is a protocol built on top of TCP that ensures accurate local time-keeping with reference to radio and atomic clocks located on the Internet.
AltNTPIP, page 5-11—Use to configure an alternate NTP server IP address.
ConnectMode, page 5-32—Used to control the connection mode of the H.323 protocol.
Polarity Settings
You can control line polarity of the Cisco ATA FXS ports when a call is connected or disconnected by configuring the Polarity bitmap parameter (see the “Polarity” section on page 5-39).
Additional H.323 Services
Progress Tones
Values for the following parameters (all defined in the “Tone Configuration Parameters” section on
page 5-41) must be determined based on the country in which the Cisco ATA is located:
DialTone
BusyTone
ReorderTone
RingBackTone
CallWaitTone
AltertTone
Selecting DTMF and Hookflash Transmission Methods
The Cisco ATA is designed to use H.245 messages to relay DTMF and hookflash events. Both the H.245 alphanumeric IE method and the H.245 signal IE method are supported for transporting DTMF events. The H.245 signal IE method has higher precedence if the far end also supports this method.
Use bits 4-5 (Phone 1 port) and 20-21 (Phone 2 port) of the AudioMode parameter to configure the DTMF transmission method.
Use bit 6-7 (Phone 1 port) and 22-23 (Phone 2 port) of the AudioMode parameter to configure the hookflash transmission method.
Related Configuration Parameter
AudioMode, page 5-24
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
4-11
Page 74
Chapter 4 Basic and Additional H.323 Services
Complete Reference Table of all Cisco ATA H.323 Services
Selecting H.323 Connection and H.245 Transmission Methods
You can configure the H.323 connection method and the H.245 transmission method. Use Bit 0 of the ConnectMode parameter to select either the slow-start procedure or the fast-start procedure for the H.323 connection. Use Bit 1 of the ConnectMode parameter to select either a separate H.245 connection or H.245 tunneling for H.245-message transmission.
Related Configuration Parameter
ConnectMode, page 5-32—Bits 0 and 1
Setting Dial Plans
You can set specific dial plan rules and timeout values. Many of these values are determined on a country-by-country basis.
Related Parameter
DialPlan, page 5-52
Complete Reference Table of all Cisco ATA H.323 Services
Table 4-4 is a reference table that lists all configurable features for the Cisco ATA (using H.323), and
includes links to the detailed descriptions of the parameters used for configuring these features.
Table 4-4 Configurable Features and Related Parameters
Configurable Features Related Parameters
Audio Media Features
Low bit-rate codec selection (G.723.1, G.729)
Silence suppression
RTP media port
Preferred audio codec for transmitting and
receiving voice data
RTP packet size
Audio cut-through configuration ConnectMode, page 5-32
Caller ID format CallerIdMethod, page 5-38
DTMF and hookflash transmission methods AudioMode, page 5-24
Debug and Diagnosis NPrintf, page 5-61
Dial plans DialPlan, page 5-52
Fax Services Features
Fax services mode selection
Audio Media Parameters
LBRCodec, page 5-23
AudioMode, page 5-24
MediaPort, page 5-21
TxCodec, page 5-22, RxCodec, page 5-22
NumTxFrames, page 5-25
Fax Services Parameters
AudioMode, page 5-24, ConnectMode,
page 5-32
Named Signaling Event (NSE) payload type for
fax pass-through
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
4-12
ConnectMode, page 5-32
OL-4804-01
Page 75
Chapter 4 Basic and Additional H.323 Services
Table 4-4 Configurable Features and Related Parameters (continued)
Configurable Features Related Parameters
H.323 connection method and H.245 transmission method
H.323 endpoint configuration:
Complete Reference Table of all Cisco ATA H.323 Services
ConnectMode, page 5-32
H.323 endpoint parameters:
E.164 phone number configuration
H.323 gatekeeper configuration
UID0, page 5-16, UID1, page 5-17
GkOrProxy, page 5-13, GkId, page 5-14,
GkTimeToLive, page 5-14, AltGk, page 5-14, AltGkTimeOut, page 5-15, Con­nectMode, page 5-32
Authentication
AutMethod, page 5-20, UseLoginID,
page 5-19, LoginID0, page 5-18, LoginID1, page 5-19, UID0, page 5-16, UID1, page 5-17, PWD0, page 5-16, PWD1, page 5-18, NTPIP, page 5-10, AltNTPIP, page 5-11
Gateway configuration
Gateway, page 5-20, GkOrProxy, page
5-13
IP dialing configuration
IPDialPlan, page 5-60, DialPlan, page
5-52
Hook-flash detection timing configuration SigTimer, page 5-31
Warmline/hotline support (PLAR feature) ‘H’ Rule to Support Hot/Warm Line, page
5-54
Network ringback tone feature ConnectMode, page 5-32
Network-related features:
Cisco Discovery Protocol (CDP)—on/off
Network-related Parameters:
OpFlags, page 5-34
OL-4804-01
DHCP configuration
DNS configuration
Static IP configuration
DHCP, page 5-8, OpFlags, page 5-34
DNS1IP, page 5-11, DNS2IP, page 5-12
StaticIp, page 5-9, StaticRoute, page 5-9,
StaticNetMask, page 5-10
VLAN configuration
OpFlags, page 5-34, VLANSetting, page
5-12
Network timing configuration TimeZone, page 5-36, NTPIP, page 5-10,
AltNTPIP, page 5-11
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
4-13
Page 76
Complete Reference Table of all Cisco ATA H.323 Services
Table 4-4 Configurable Features and Related Parameters (continued)
Configurable Features Related Parameters
User Interface and TFTP Features:
User interface password
Chapter 4 Basic and Additional H.323 Services
User Interface and TFTP Parameters:
UIPassword, page 5-3
TFTP Configuration
UseTFTP, page 5-4, TftpURL, page 5-5,
OpFlags, page 5-34
TFTP Encryption key
EncryptKey, page 5-6, EncryptKeyEx,
page 5-7
TFTP image upgrade
upgradecode (see the “Upgrading the
Signaling Image from a TFTP Server” section on page 8-1)
TFTP configuration file retrieval interval
HTTP refresh/reset access—disable/enable
Web configuration—enable/disable
Packet Precedence Features:
Type of Service (ToS) configuration
802.1P Class of Service (Cos) Bit configuration
CfgInterval, page 5-6
OpFlags, page 5-34
OpFlags, page 5-34
Packet Precedence Parameters:
TOS, page 5-26
VLANSetting, page 5-12
Polarity settings for FXS ports Polarity, page 5-39
Ring-cadence format RingOnOffTime, page 5-51
Supplementary services configuration CallCmd, page 5-29, CallFeatures, page 5-27,
PaidFeatures, page 5-28
Tone format: BusyTone, CallWaitTone ConfirmTone, DialTone, ReorderTone, and Ring-
Tone Configuration Parameters, page 5-41, SigTimer, page 5-31
BackTone parameters
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
4-14
OL-4804-01
Page 77
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.
Parameters are divided into categories based on their functionality. The following categories of parameters are covered in this section:
User Interface (UI) Security Parameter, page 5-3
Parameters for Configuration Method and Encryption, page 5-4
Network Configuration Parameters, page 5-8
H.323 Parameters, page 5-13
Audio Configuration Parameters, page 5-21
Operational Parameters, page 5-26
Telephone Configuration Parameters, page 5-37
Tone Configuration Parameters, page 5-41
Dial Plan Parameters, page 5-52
Diagnostic Parameters, page 5-60
CFGID—Version Parameter for Cisco ATA Configuration File, page 5-63
The following list contains general configuration information:
Your configuration file must begin with #txt.
The Cisco ATA uses the following parameter types:
Alphanumeric string
Array of short integers
Boolean (1 or 0)
Bitmap value—unsigned hexadecimal integer (for specifying bits in a 32-bit integer)
Note Bits are numbered from right to left, starting with bit 0.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-1
Page 78
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 ATA 186 and Cisco ATA 188 are explicitly stated.
Note This section contains recommended values for the United States and other countries as configuration
examples for certain parameters. For detailed recommendations of tone-parameter values by country, see
Appendix E, “Recommended Cisco ATA Tone Parameter Values by Country.”
Chapter 5 Parameters and Defaults
Note A tool called bitaid.exe is bundled with your Cisco ATA software. You can use this tool
to help you configure values of Cisco ATA bitmap parameters. The tool prompts you for the necessary information.
Extended IP address—IP address followed by port number (for example, 192.168.2.170.9001)
IP address (e.g. 192.168.2.170)
Integer (32-bit integer)
Numeric digit string
Configuration Text File Template
This is a listing of the h323_example.txt text file, without its annotations, that comes bundled with the Cisco ATA software.
You can make a copy of this file and use it as a template for creating your own default configuration 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 h323_example.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 EncryptKeyEx: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 NTPIP:0.0.0.0 AltNTPIP:0.0.0.0 DNS1IP:0.0.0.0 DNS2IP:0.0.0.0 VLANSetting:0x0000002b GkOrProxy:0 GkId:. GkTimeToLive:0 AltGk:0
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-2
OL-4804-01
Page 79
Chapter 5 Parameters and Defaults
AltGkTimeOut:0 UID0:0 UID1:0 UseLoginID:0 LoginID0:0 LoginID1:0 PWD0:0 PWD1:0 AutMethod:0x00000000 GateWay:0 MediaPort:16384 RxCodec:1 TxCodec:1 LBRCodec:0 AudioMode:0x00150015 NumTxFrames:2 TOS:0x0000A8B8 CallFeatures:0xffffffff PaidFeatures:0xffffffff 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; FeatureTimer:0x00000000 FeatureTimer2:0x0000001e SigTimer:0x01418564 ConnectMode:0x00060400 OpFlags:0x00000002 TimeZone:17 CallerIdMethod:0x00019e60 Polarity: 0 FXSInputLevel:-1 FXSOutputLevel:-4 DialTone:2,31538,30831,1380,1740,1,0,0,1000 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 RingOnOffTime:2,4,25 DialPlan:*St4-|#St4-|911|1>#t8.r9t2-|0>#t811.rat4-|^1t4>#.­IPDialPlan: 1 NPrintf:0 TraceFlags:0x00000000 SyslogIP:0.0.0.0.514 SyslogCtrl:0x00000000
User Interface (UI) Security Parameter
The sections that follow describe these parameters.
User Interface (UI) Security Parameter
This section contains only one parameter—UIPassword.
UIPassword
Description
This parameter controls access to web page or voice configuration menu interface. To set a password, enter a value other than zero. To have the user prompted for this password when attempting to perform a factory reset or upgrade using the voice configuration menu, see the “OpFlags” section on page 5-34.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-3
Page 80
Parameters for Configuration Method and Encryption
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 When UIPassword contains letters, you cannot enter the password from the telephone keypad.
Value Type
Alphanumeric string
Range
Maximum nine characters
Default
0
Voice Configuration Menu Access Code
7387277
Chapter 5 Parameters and Defaults
Related Parameter
OpFlags, page 5-34—Bit 7
Parameters for Configuration Method and Encryption
This section describes parameters for instructing the Cisco ATA about how to locate its TFTP server and how to encrypt its configuration file:
UseTFTP, page 5-4
TftpURL, page 5-5
CfgInterval, page 5-6
EncryptKey, page 5-6
EncryptKeyEx, page 5-7
UseTFTP
Settings
1—Use the TFTP server for Cisco ATA configuration.
0—Do not use the TFTP server for Cisco ATA configuration.
Value Type
Boolean
Range
0 or 1
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-4
OL-4804-01
Page 81
Chapter 5 Parameters and Defaults
Default
1
Voice Configuration Menu Access Code
305
Related Parameters
TftpURL, page 5-5
EncryptKey, page 5-6
EncryptKeyEx, page 5-7
OpFlags, page 5-34—bits 0 and 3
CfgInterval, page 5-6
TftpURL
Description
Use this parameter to specify the IP address or URL of the TFTP server. This string is needed if the DHCP server does not provide the TFTP server IP address. When the TftpURL parameter is set to a non-zero value, this parameter has priority over the TFTP server IP address supplied by the DHCP server.
Parameters for Configuration Method and Encryption
Optionally, you can include the path prefix to the TFTP file to download.
For example, if the TFTP server IP address is 192.168.2.170 or www.cisco.com, and the path to download the TFTP file is in /ata186, you can specify the URL as 192.168.2.170/ata186 or www.cisco.com/ata186.
Note From the voice configuration menu, you can only enter the IP address; from the web server, you can
enter the actual URL.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
905
Related Parameters
UseTFTP, page 5-4
CfgInterval, page 5-6
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-5
Page 82
Parameters for Configuration Method and Encryption
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
Chapter 5 Parameters and Defaults
EncryptKey
Note Cisco recommends using the stronger Cisco ATA encryption method, which requires the use of the
Voice Configuration Menu Access Code
80002
Related Parameters
UseTFTP, page 5-4
TftpURL, page 5-5
Description
This parameter specifies the encryption key that is used to encrypt the Cisco ATA configuration file on the TFTP server.
The cfgfmt tool, which is used to create a Cisco ATA binary configuration file (see the “Using
Encryption With the cfgfmt Tool” section on page 3-12), automatically encrypts the binary file when the
EncryptKey parameter has a value other than 0. The cfgfmt tool uses the rc4 encryption algorithm.
If this parameter value is set to 0, the Cisco ATA configuration file on the TFTP server is not encrypted.
EncryptKeyEx parameter. For more information, see the “EncryptKeyEx” section on page 5-7.
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
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-6
OL-4804-01
Page 83
Chapter 5 Parameters and Defaults
Range
Maximum number of characters: 8
Default
0
Voice Configuration Menu Access Code
320
Related Parameters
UseTFTP, page 5-4
TftpURL, page 5-5
EncryptKeyEx, page 5-7
EncryptKeyEx
Parameters for Configuration Method and Encryption
Description
This parameter specifies an encryption key that is stronger than the key specified with the EncryptKey parameter. This stronger key is used to encrypt the Cisco ATA configuration file on the TFTP server.
Note Cisco recommends using the EncrpytKeyEx parameter instead of the EncryptKey parameter for the
strongest possible encryption of the Cisco ATA configuration file.
When the EncryptKeyEx parameter is set to a non-zero value, the Cisco ATA uses this value as the encryption key and ignores any value that has been set for the EncryptKey parameter. The cfgfmt tool, which is used to create a Cisco ATA binary configuration 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 The cfgfmt tool (version 2.3) program generate an ata<macaddress>.x file in addition to an
ata<macaddress> file if the EncryptKeyEx parameter is specified. You should place both such configuration files on the TFTP server.
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.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-7
Page 84
Network Configuration Parameters
Value Type
Hexadecimal string of the form:
Rc4PasswdInHex/macinHex_12
rc4KeyInHex_n is a hexadecimal string of one to 64 characters.
/macInHex_12 is the optional extension consisting of a forward slash ( / ) followed by the six-byte
MAC address of the Cisco ATA to which the configuration file will be downloaded.
Range
Maximum number of characters: 64
Default
0
Voice Configuration Menu Access Code
Not applicable for this parameter.
Related Parameters
UseTFTP, page 5-4
Chapter 5 Parameters and Defaults
TftpURL, page 5-5
EncryptKey, page 5-6
Network Configuration Parameters
This section includes the parameters for enabling or disabling the use of a DHCP server to obtain IP address information, and parameters that you need to statically configure if you disable DHCP:
DHCP, page 5-8
StaticIp, page 5-9
StaticRoute, page 5-9
StaticNetMask, page 5-10
NTPIP, page 5-10
AltNTPIP, page 5-11
DNS1IP, page 5-11
DNS2IP, page 5-12
VLANSetting, page 5-12
DHCP
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.
1—Enable DHCP
0—Disable DHCP
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-8
OL-4804-01
Page 85
Chapter 5 Parameters and Defaults
Value Type
Boolean
Range
0 or 1
Default
1
Voice Configuration Menu Access Code
20
Related Parameters
StaticIp, page 5-9
StaticRoute, page 5-9
StaticNetMask, page 5-10
OpFlags, page 5-34—Bits 3 and 11
Network Configuration Parameters
StaticIp
StaticRoute
Description
Use this parameter to 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
DHCP, page 5-8
StaticRoute, page 5-9
StaticNetMask, page 5-10
Description
Use this parameter to statically assign the Cisco ATA route if the DHCP parameter is set to 0.
Value Type
IP address
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-9
Page 86
Network Configuration Parameters
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
Chapter 5 Parameters and Defaults
DHCP, page 5-8
StaticIp, page 5-9
StaticNetMask, page 5-10
NTPIP
Value Type
IP address
Default
255.255.255.0
Voice Configuration Menu Access Code
10
Related Parameters
DHCP, page 5-8
StaticIp, page 5-9
StaticRoute, page 5-9
Description
This parameter is the NTP IP address, required if DHCP server does not provide one.
The Cisco ATA requires an NTP Server from which to obtain Coordinated Universal Time (UTC) to time-stamp incoming calls (H.323 and SIP) to drive an external Caller-ID device.
DHCP may also supply a NTP server. If NTPIP is specified, it overwrites the value supplied by DHCP. NTPIP is ignored if its value is 0 or 0.0.0.0.
The user must not specify a port parameter. The Cisco ATA uses the default NTP port only.
Value Type
IP address
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-10
OL-4804-01
Page 87
Chapter 5 Parameters and Defaults
Default
0.0.0.0
Voice Configuration Menu Access Code
141
Related Parameters
AltNTPIP, page 5-11
TimeZone, page 5-36
AltNTPIP
Description
This parameter is the alternate NTP IP address, if you want redundancy. You can set this parameter to 0 or point to the same NTPIP if only one NTP server exists.
Value Type
IP address
Network Configuration Parameters
DNS1IP
Default
0.0.0.0
Voice Configuration Menu Access Code
142
Related Parameters
NTPIP, page 5-10
TimeZone, page 5-36
Description
This parameter is for setting the primary domain name 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
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-11
Page 88
Network Configuration Parameters
DNS2IP
Chapter 5 Parameters and Defaults
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
VLANSetting
Description
This parameter is for firmware version 2.15 and above.
Bitmap definitions are as follows for the VLANSetting parameter:
Bits 0-2—Specify VLAN Class of Service (CoS) bit value (802.1P priority) for signaling IP packets.
Bits 3-5—Specify VLAN CoS bit value (802.1P priority) for voice IP packets.
Bits 6-17—Reserved.
Bits 18-29—User-specified 802.1Q VLAN ID.
Bits 30-31—Reserved.
Value Type
Bitmap
Default
0x0000002b
Voice Configuration Menu Access Code
324
Related Parameter
OpFlags, page 5-34
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-12
OL-4804-01
Page 89
Chapter 5 Parameters and Defaults
H.323 Parameters
This sections describes the following parameters, which include H.323 Gatekeeper configuration parameters:
GkOrProxy, page 5-13
GkId, page 5-14
GkTimeToLive, page 5-14
AltGk, page 5-14
AltGkTimeOut, page 5-15
UID0, page 5-16
PWD0, page 5-16
UID1, page 5-17
PWD1, page 5-18
LoginID0, page 5-18
LoginID1, page 5-19
H.323 Parameters
GkOrProxy
UseLoginID, page 5-19
AutMethod, page 5-20
Gateway, page 5-20
Description
This parameter is the IP address of the primary H.323 gatekeeper.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0—Disables gatekeeper-routed calls.
Voice Configuration Menu Access Code
5
Related Parameters
AltGk, page 5-14
AltGkTimeOut, page 5-15
GkTimeToLive, page 5-14
GkId, page 5-14
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-13
Page 90
H.323 Parameters
GkId
Chapter 5 Parameters and Defaults
Description
This parameter is the identifier for the primary H.323 gatekeeper.
Value Type
Alphanumeric string
Default
. (not specified)
Range
Maximum 31 characters
Voice Configuration Menu Access Code
91
GkTimeToLive
AltGk
Description
This parameter specifies the “time to live” value that is used when the Cisco ATA registers with the H.323 gatekeeper. The registration is valid until the configured time expires.
Value Type
Integer
Default
0
Range
30 to 4294967295 seconds
Voice Configuration Menu Access Code
250
Description
You have the option of using this parameter to statically specify the IP address of an alternate H.323 gatekeeper.
Value Type
Alphanumeric string
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-14
OL-4804-01
Page 91
Chapter 5 Parameters and Defaults
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
6
Related Parameter
AltGkTimeOut, page 5-15
AltGkTimeOut
Description
You can use this parameter to specify the timeout in seconds before the Cisco ATA fails back to the primary gatekeeper from the backup gatekeeper. When the Cisco ATA switches to a different H.323 gatekeeper, the setting of Bit 3 of the ConnectMode parameter (see the “ConnectMode” section on
page 5-32) determines whether the Cisco ATA re-registers with the H.323 gatekeeper.
H.323 Parameters
Value Type
Integer
Default
0—The Cisco ATA continues to use the backup gatekeeper until it fails before attempting to fail back to the primary gatekeeper.
Range
30 to 4294967295 seconds
Voice Configuration Menu Access Code
251
Related Parameters
AltGk, page 5-14
ConnectMode, page 5-32—Bit 3
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-15
Page 92
H.323 Parameters
UID0
Chapter 5 Parameters and Defaults
Description
This parameter is the User ID (E.164 phone number) for the Phone 1 port. If the value is set to zero, the port will be disabled and no dial tone will sound.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
3
PWD0
Related Parameters
UID1, page 5-17
PWD0, page 5-16
PWD1, page 5-18
UseLoginID, page 5-19
LoginID0, page 5-18
LoginID1, page 5-19
Description
This parameter is the password for the Phone 1 port.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-16
OL-4804-01
Page 93
Chapter 5 Parameters and Defaults
Voice Configuration Menu Access Code
4
Related Parameters
UID0, page 5-16
UID1, page 5-17
PWD1, page 5-18
UseLoginID, page 5-19
LoginID0, page 5-18
LoginID1, page 5-19
AutMethod, page 5-20
UID1
Description
This parameter is the User ID (E.164 phone number) for the Phone 2 port. If the value is set to zero, the port will be disabled and no dial tone will sound.
H.323 Parameters
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
13
Related Parameters
UID0, page 5-16
PWD0, page 5-16
PWD1, page 5-18
UseLoginID, page 5-19
LoginID0, page 5-18
LoginID1, page 5-19
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-17
Page 94
H.323 Parameters
PWD1
Chapter 5 Parameters and Defaults
Description
This parameter is the password for the Phone 2 port.
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
14
Related Parameters
UID0, page 5-16
LoginID0
UID1, page 5-17
PWD0, page 5-16
UseLoginID, page 5-19
LoginID0, page 5-18
LoginID1, page 5-19
AutMethod, page 5-20
Description
This parameter is the H.323 login ID for the Phone 1 port of the Cisco ATA.
This value is used for registration and authentication if the UseLoginID parameter is set to 1.
If the LoginID0 and LoginID1 parameter values are identical, only one gatekeeper registration is performed for both ports, in which case the LoginID0 value 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
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-18
OL-4804-01
Page 95
Chapter 5 Parameters and Defaults
Voice Configuration Menu Access Code
46
Related Parameters
LoginID1, page 5-19
PWD0, page 5-16
PWD1, page 5-18
UseLoginID, page 5-19
AutMethod, page 5-20
LoginID1
Description
This parameter is the H.323 login ID for the Phone 2 port of the Cisco ATA.
This value is used for registration and authentication if the UseLoginID parameter is set to 1.
If the LoginID0 and LoginID1 parameter values are identical, only one gatekeeper registration is performed for both ports, in which case the LoginID0 value is used as the H.323 ID, and the UID0 and UID1 parameter values are used for the two E.164 phone numbers.
H.323 Parameters
UseLoginID
Value Type
Alphanumeric string
Range
Maximum number of characters: 51
Default
0
Voice Configuration Menu Access Code
47
Related Parameters
LoginID0, page 5-18
PWD0, page 5-16
PWD1, page 5-18
UseLoginID, page 5-19
AutMethod, page 5-20
Description
0—Use UID0 and UID1 as the authentication ID.
1—Use LoginID0 and LoginID1 as the authentication ID.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-19
Page 96
H.323 Parameters
AutMethod
Chapter 5 Parameters and Defaults
Value Type
Boolean
Range
0 or 1
Default
0
Voice Configuration Menu Access Code
93
Description
Use this parameter to select the desired authentication method, with the following possible values:
0—Do not use authentication (default)
1—Use Cisco registration-level security
2—Use Cisco administration-level security on a per-call basis
Value Type
Bitmap
Default
0x00000000
Voice Configuration Menu Access Code
92
Related Parameters
LoginID0, page 5-18
LoginID1, page 5-19
PWD0, page 5-16
PWD1, page 5-18
NTPIP, page 5-10
AltNTPIP, page 5-11
Gateway
Description
Use this parameter to specify the H.323 gateway 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.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-20
OL-4804-01
Page 97
Chapter 5 Parameters and Defaults
Value Type
Alphanumeric string
Range
Maximum number of characters: 31
Default
0
Voice Configuration Menu Access Code
11
Audio Configuration Parameters
This section describes the following audio parameters, which allow you to configure such items as codecs and silence suppression:
MediaPort, page 5-21
Audio Configuration Parameters
MediaPort
RxCodec, page 5-22
TxCodec, page 5-22
LBRCodec, page 5-23
AudioMode, page 5-24
NumTxFrames, page 5-25
TOS, page 5-26
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
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-21
Page 98
Audio Configuration Parameters
RxCodec
Chapter 5 Parameters and Defaults
Related Parameters
TOS, page 5-26
VLANSetting, page 5-12
Description
Use this parameter to specify receiving-audio codec preference. The following values are valid:
0—G.723 (can be selected only if LBRCodec is set to 0)
1—G.711A-law
2—G.711µ-law
3—G.729A (can be selected only if LBRCodec is set to 3)
Value Type
Integer
TxCodec
Range
0-3
Default
2
Voice Configuration Menu Access Code
36
Related Parameters
LBRCodec, page 5-23
NumTxFrames, page 5-25
TxCodec, page 5-22
AudioMode, page 5-24
Description
Use this parameter to specify the transmitting-audio codec preference. The following values are valid:
0—G.723 (can be selected only if LBRCodec is set to 0)
1—G.711A-law
2—G.711µ-law
3—G.729A (can be selected only if LBRCodec is set to 3)
Value Type
Integer
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-22
OL-4804-01
Page 99
Chapter 5 Parameters and Defaults
Range
0-3
Default
2
Voice Configuration Menu Access Code
37
Related Parameters
LBRCodec, page 5-23
NumTxFrames, page 5-25
RxCodec, page 5-22
AudioMode, page 5-24
LBRCodec
Audio Configuration Parameters
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 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.
The following values are valid:
0—Select G.723.1 as the low-bit-rate codec.
3—Select either G.729 as the low-bit-rate codec.
Value Type
Integer
Range
0 or 3
Default
0
Voice Configuration Menu Access Code
300
Related Parameters
AudioMode, page 5-24—Bits 1 and 17
TxCodec, page 5-22
RxCodec, page 5-22
NumTxFrames, page 5-25
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
OL-4804-01
5-23
Page 100
Audio Configuration Parameters
AudioMode
Chapter 5 Parameters and Defaults
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-1 on page 5-24 provides definitions for each bit.
Value Type
Bitmap
Default
0x00150015
Voice Configuration Menu Access Code
312
Related Parameters
LBRCodec, page 5-23
ConnectMode, page 5-32
RxCodec, page 5-22
Table 5-1 AudioMode Parameter Bit Definitions
Bit Number Definition
0 and 16 0/1—Disable/enable silence suppression for all audio codecs. Silence suppression is enabled by
default.
1 and 17 0—Enable selected low-bit-rate codec in addition to G.711. This setting is the default.
1—Enable G.711 only.
2 and 18 0/1—Disable/enable fax CED tone detection. This feature is enabled by default.
3 and 19 Reserved.
4-5 and 20-21 DTMF Transmission Method:
0—Always in-band.
1—By negotiation.
2—Always out-of-band.
3—Reserved.
6-7 and 22-23 Hookflash Transmission Method:
0—Disable sending OOB hookflash message.
1—By negotiation (H.245 message).
2—Always out-of-band (H.245 message).
3—Use Q931message to send user keypad information for DTMF or hookflash transmission.
8-15 and 23-31 Reserved.
Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for H.323 (version 3.0)
5-24
OL-4804-01
Loading...