Xena OpenAutomation CLI Command Documentation

This documentation provides a comprehensive guide to using the Xena OpenAutomation CLI, including installation instructions, usage examples, and a detailed reference guide to all available commands. The documentation is organized by command and includes detailed descriptions of each command, along with usage examples and expected output.

In addition to the command reference, the Xena Networks website also provides other resources for learning about and using the XOA platform, including user guides, tutorials, and code examples. The Xena Networks community forum is also a valuable resource for getting help and support with the XOA CLI and other Xena products.

Overall, the XOA CLI command documentation provides a wealth of information for network engineers and developers who are interested in managing Xena test equipment and automating network testing tasks using the command line. With its comprehensive command reference and usage examples, the documentation can help users get up and running quickly and efficiently with the XOA CLI.

The target audience of this document is test specialists who develop and run automated test scripts using Xena test equipment. Users of this document should have the following knowledge and experience:

• Familiarity with the operating system of the development environment.

• Familiarity with Xena test equipment.

• Working knowledge of data communications theory and practice.

Important

To learn XOA Python API, go to Xena OpenAutomation Python API Documentation.

---

Table of Contents

• 1. Introduction
  • 1.1. Ways to Control Xena Testers
  • 1.2. CLI to Chassis
• 2. Basics
  • 2.1. Command Syntax
    • 2.1.1. set Syntax
    • 2.1.2. get Syntax
  • 2.2. Concurrent Sessions
    • 2.2.1. Manage CLI Session
    • 2.2.2. Multiple Concurrent Sessions
  • 2.3. Parameter Data Types
  • 2.4. Status Messages
  • 2.5. Defaults and Wildcarding
  • 2.6. Special Commands
  • 2.7. Relation to ValkyrieManager
  • 2.8. Relation to Port Configuration Files
  • 2.9. Sample XOA CLI Script
    • 2.9.1. Input
    • 2.9.2. Output
• 3. CLI Reference
  • 3.1. Chassis
    • 3.1.1. Identification
    • 3.1.2. Management Address
    • 3.1.3. Control
    • 3.1.4. Management Session
    • 3.1.5. Status
    • 3.1.6. Time Service
    • 3.1.7. Capability
    • 3.1.8. Misc
    • 3.1.9. Full Config
  • 3.2. Module
    • 3.2.1. Identification
    • 3.2.2. Media Configuration
    • 3.2.3. Status
    • 3.2.4. Timing
    • 3.2.5. Clock Sweep
    • 3.2.6. SMA
    • 3.2.7. Impairment
    • 3.2.8. Capability
    • 3.2.9. License
    • 3.2.10. Misc
    • 3.2.11. Full Config
  • 3.3. Port
    • 3.3.1. General
    • 3.3.2. Traffic Generation
    • 3.3.3. Layer-1
    • 3.3.4. Impairment
    • 3.3.5. Config
    • 3.3.6. Full Config
  • 3.4. Misc
    • 3.4.1. Vulcan Port States
    • 3.4.2. CLI for Vulcan
  • 3.5. Special
    • 3.5.1. SYNC
• 4. Glossary of Terms

• Search Page