About this Guide
The information in this section is provided to help you navigate this guide and make better use of its content. A list of related documentation is also included.
The Third-Party Software License document is included with the download package.
Purpose
This guide describes the structure and conventions of the IxExplorer Tcl API and provides detailed information on all API commands. Information is provided on protocol support and indicates the commands, sub-commands, options, and statistics that apply to each protocol.
Manual Content
This guide contains the following sections:
Section |
Description |
---|---|
About this Guide |
Provides information on this guide, including its purpose, content, and related documentation. Also explains how to contact technical support. |
Chapter 1, Tcl API Overview |
Provides a brief overview of the Tcl API and the features that are new to this release. |
Chapter 2, Quick Start |
An overview of a complete, useful Tcl example program. Using this, the basic flow of programming and operation can be viewed. |
Chapter 3, High-Level and Utility API Description |
Organizes the High-Level and Utility APIs into related discussion groups and describes how to use them at a high level. |
Chapter 4, Programming |
Explains the basic structure and operation of all of the Tcl Commands. |
Chapter 5, IxTclHal API Description |
Organizes the APIs into related discussion groups and describes how to use them at a high level. |
Appendix 1, IxTclHAL Commands |
An alphabetical set of reference sheets for all non-protocol related Tcl Commands. |
Appendix 2, Utility Commands |
An alphabetical set of reference sheets for additional test related commands. |
Appendix 3, High-Level API |
Commands which perform a combination of functions against a number of ports. |
Appendix 4, IxTcl Server Usage |
Explains the usage of Tcl Server. |
Appendix 5, Reserved Keywords |
Provides the keywords that are used in IxOS setup. These keywords should not be used as variable names in customer scripts, failing which they will conflict with code execution and exhibit unwanted behavior. |
Related Documentation
The following guides may help you learn more about Tcl API for IxExplorer. The guides are available on the CD shipped with the application, as well as on the Ixia website at www.ixiacom.com.
- IxExplorer User Guide—Details the usage of the IxExplorer GUI for operation with an Ixia chassis and Ixia load modules.
- Ixia Platform Reference Guide—Provides a detailed list of all currently supported Ixia chassis and Ixia load modules, as well as general information regarding various technologies covered by Ixia products.
- IxServer User Guide—Details the usage of the IxServer GUI for operation on an Ixia chassis.
Technical Support
You can obtain technical support for any Ixia product by contacting Ixia Technical Support by any of the methods mentioned on the inside cover of this guide. Technical support from Ixia’s corporate headquarters is available Monday through Friday from 06:00 to 18:00, Pacific Standard Time (excluding American holidays). Technical support from Ixia’s EMEA and India locations is available Monday through Friday, 08:00 to 17:00 local time (excluding local holidays).