cc/td/doc/product/software/ios122/rel_docs
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

About This Guide

About This Guide

This section describes the objectives, audience, organization, and conventions of the Cisco Gatekeeper External Interface Reference, Version 3.

Document History

The versions of this guide are listed in Table 1.


Table 1: Document History
Title Software Version Location

Cisco Gatekeeper External Interface Reference, Version 1

12.2(1)T

http://www.cisco.com/univercd/cc/td/doc/product/
software/ios121/121rel/gktmp/index.htm

Cisco Gatekeeper External Interface Reference, Version 2

12.1(5)XM

http://www.cisco.com/univercd/cc/td/doc/product/
software/ios121/121rel/gktmpv2/index.htm

Cisco Gatekeeper External Interface Reference, Version 3

12.2(2)XA

http://www.cisco.com/univercd/cc/td/doc/product/
software/ios122/rel_docs/gktmpv3/index.htm

Document Objectives

This guide is designed to help you understand and implement an external interface to the Cisco IOS Gatekeeper using the Cisco Gatekeeper Transaction Message Protocol (GKTMP) and application programming interface (API).

Audience

This guide is intended for application programmers who want to develop an application that interfaces with the Cisco IOS Gatekeeper.

Document Organization

This document is divided into the following chapters shown in Table 2:


Table 2: Organization
Chapter Title Description

Chapter 1

Overview of H.323

Provides a high-level overview of H.323.

Chapter 2

Overview of the Cisco IOS Gatekeeper

Provides an overview of the features and functions of the Cisco IOS Gatekeeper.

Chapter 3

Implementing an External Interface to the Cisco IOS Gatekeeper

Provides information about and examples of implementing an external interface to the Cisco IOS Gatekeeper using the GKTMP and the Cisco IOS Gatekeeper API.

Chapter 4

GKTMP Messages

Describes the messages used with the GKTMP.

Chapter 5

Gatekeeper API Functions and Structures

Describes the functions provided with the Cisco IOS Gatekeeper API.

Chapter 6

GKTMP Command Reference

Describes the Cisco IOS software commands used to configure triggers for a Cisco IOS Gatekeeper.

Related Documentation

For additional information about the commands used in conjunction with the GKTMP, see the following documents:

Cisco IOS Voice, Video, and Fax Configuration Guide , Release 12.2

Cisco IOS Voice, Video, and Fax Command Reference , Release 12.2

Cisco High Performance Gatekeeper

Cisco H.323 Scalability and Interoperability Enhancements

Command Syntax Conventions

Table 3 describes the syntax used with the commands in this document.


Table 3: Command Syntax Guide
Convention Description

boldface

Commands and keywords.

italic

Command input that is supplied by you.

[     ]

Keywords or arguments that appear within square brackets are optional.

{ x | x | x }

A choice of keywords (represented by x) appears in braces separated by vertical bars. You must select one.

^ or Ctrl

Represent the key labeled Control. For example, when you read ^D or Ctrl-D, you should hold down the Control key while you press the D key.

screen font

Examples of information displayed on the screen.

boldface screen font

Examples of information that you must enter.

<     >

Nonprinting characters, such as passwords, appear in angled brackets.

[     ]

Default responses to system prompts appear in square brackets.

Obtaining Documentation

The following sections provide sources for obtaining documentation from Cisco Systems.

World Wide Web

You can access the most current Cisco documentation on the World Wide Web at the following sites:

Documentation CD-ROM

Cisco documentation and additional literature are available in a CD-ROM package, which ships 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 as an annual subscription.

Ordering Documentation

Cisco documentation is available in the following ways:

http://www.cisco.com/cgi-bin/order/order_root.pl

http://www.cisco.com/go/subscription

Documentation Feedback

If you are reading Cisco product documentation on the World Wide Web, you can submit technical comments electronically. Click Feedback in the toolbar and select Documentation. After you complete the form, click Submit to send it to Cisco.

You can e-mail your comments to bug-doc@cisco.com.

To submit your comments by mail, use the response card behind the front cover of your document, or write to the following address:

Attn Document Resource Connection
Cisco Systems, Inc.
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 documentation, troubleshooting tips, and sample configurations from online tools. For Cisco.com registered users, additional troubleshooting tools are available from the TAC website.


Note   If you are an application programmer and need more information or technical assistance with GKTMP/API developer support, see Developer Support Central on CCO at http://www.cisco.com/warp/public/570/ or contact gktmp-sdp@cisco.com.

Cisco.com

Cisco.com is the foundation of a suite of interactive, networked services that provides immediate, open access to Cisco information and resources at anytime, from anywhere in the world. This highly integrated Internet application is a powerful, easy-to-use tool for doing business with Cisco.

Cisco.com provides a broad range of features and services to help customers and partners streamline business processes and improve productivity. Through Cisco.com, you can find information about Cisco and our networking solutions, services, and programs. In addition, you can resolve technical issues with online technical support, download and test software packages, and order Cisco learning materials and merchandise. Valuable online skill assessment, training, and certification programs are also available.

Customers and partners can self-register on Cisco.com to obtain additional personalized information and services. Registered users can order products, check on the status of an order, access technical support, and view benefits specific to their relationships with Cisco.

To access Cisco.com, go to the following website:

http://www.cisco.com

Technical Assistance Center

The Cisco TAC website is available to all customers who need technical assistance with a Cisco product or technology that is under warranty or covered by a maintenance contract.

Contacting TAC by Using the Cisco TAC Website

If you have a priority level 3 (P3) or priority level 4 (P4) problem, contact TAC by going to the TAC website:

http://www.cisco.com/tac

P3 and P4 level problems are defined as follows:

In each of the above cases, use the Cisco TAC website to quickly find answers to your questions.

To register for Cisco.com, go to the following website:

http://www.cisco.com/register/

If you cannot resolve your technical issue by using the TAC online resources, Cisco.com registered users can open a case online by using the TAC Case Open tool at the following website:

http://www.cisco.com/tac/caseopen

Contacting TAC by Telephone

If you have a priority level 1 (P1) or priority level 2 (P2) problem, contact TAC by telephone and immediately open a case. To obtain a directory of toll-free numbers for your country, go to the following website:

http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml

P1 and P2 level problems are defined as follows:


hometocprevnextglossaryfeedbacksearchhelp
Posted: Fri Sep 27 04:09:13 PDT 2002
All contents are Copyright © 1992--2002 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.