Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

Xena OpenAutomation Python API Documentation

Toggle table of contents sidebar

Xena OpenAutomation Python API Documentation

Table of Content

Introduction
Getting Started
Toggle navigation of Getting Started
- Installing XOA Python API
- Quick Start
Understanding XOA Python API
Toggle navigation of Understanding XOA Python API
Test Resource Management
Command Grouping
Status Messages and Exceptions
Code Examples
API Reference
Toggle navigation of API Reference
- High-Level Functions
  Toggle navigation of High-Level Functions
- High-Level API
  Toggle navigation of High-Level API
  - Summary
  - Tester
    Toggle navigation of Tester
  - Module
    Toggle navigation of Module
    - Capabilities
    - Identification
    - Impairment
    - Media
    - Obtain
    - Reservation
    - Time and Clock
    - Advanced Timing
    - L47
      Toggle navigation of L47
      - Capture
      - License
      - Packet Engine
      - PCAP Replay
      - System
      - TLS Cipher
  - Port
    Toggle navigation of Port
    - Action
    - Port Address
    - Capabilities
    - Capture
    - Control
    - Energy Efficiency Ethernet
    - Fault
    - Identification
    - Latency
    - Link Flap
    - Multicast
    - Obtain
    - Payload
    - Preamble
    - Reservation
    - Runt
    - Speed
    - Status
    - Transceiver
    - Traffic Control
    - TX Profile
    - Unavailable Time
    - Histogram
      Toggle navigation of Histogram
      - Configuration
      - Create, Obtain, Remove
    - Filter
      Toggle navigation of Filter
      - Configuration
      - Create, Obtain, Remove
    - Match Term
      Toggle navigation of Match Term
      - Configuration
      - Create, Obtain, Remove
    - Length Term
      Toggle navigation of Length Term
      - Configuration
      - Create, Obtain, Remove
    - PCS/PMA
      Toggle navigation of PCS/PMA
    - PHY
      Toggle navigation of PHY
    - PRBS
      Toggle navigation of PRBS
      - Configuration
      - Statistics
    - Statistics
      Toggle navigation of Statistics
    - Impairment
      Toggle navigation of Impairment
      - Impairment Configuration
      - Filter
        Toggle navigation of Filter
        
        Properties
        
        Basic Filter Configuration
        Toggle navigation of Basic Filter Configuration
        
        Any
        
        L2
        
        L2+
        
        L3
        
        L4
        
        TPLD
        
        Working Filter
      - Drop
        Toggle navigation of Drop
        
        Drop Distribution
        
        Drop Scheduling
      - Misordering
        Toggle navigation of Misordering
        
        Misorder Configuration
        
        Misorder Distribution
        
        Misorder Scheduling
      - Latency/Jitter
        Toggle navigation of Latency/Jitter
        
        Latency & Jitter Configuration
        
        Latency & Jitter Distribution
        
        Latency & Jitter Scheduling
      - Duplication
        Toggle navigation of Duplication
        
        Duplication Distribution
        
        Duplication Scheduling
      - Corruption
        Toggle navigation of Corruption
        
        Corruption Configuration
        
        Corruption Distribution
        
        Corruption Scheduling
      - Policer
      - Shaper
      - Statistics
    - L47
      Toggle navigation of L47
      - Port Address
      - Capabilities & Aptitudes
      - Capture
      - Clear All
      - Identification
      - Max Packet Rate
      - Counter
        Toggle navigation of Counter
        
        Port Counters
        Toggle navigation of Port Counters
        
        ARP
        
        Clear Counters
        
        Ethernet
        
        ICMP
        
        IPv4
        
        IPv6
        
        NDP
        
        TCP
        
        All
        
        UDP
        
        Connection Group Counters
        Toggle navigation of Connection Group Counters
        
        Replay
        
        TCP
        
        TLS
        
        Transaction
        
        UDP
        
        User
      - Connection Group
        Toggle navigation of Connection Group
        
        Clear Counters
        
        Create, Obtain, Remove
        
        Description
        
        Histogram
        
        L2
        
        L3
        
        Load Profile
        
        Role
        
        Status
        
        TLS
        
        L4
        Toggle navigation of L4
        
        TCP
        
        UDP
        
        Test Application
        Toggle navigation of Test Application
        
        Raw
        
        Replay
  - Stream
    Toggle navigation of Stream
    - Custom Data Field
    - Connectivity Check
    - Packet Content
    - Create, Obtain, Remove
    - Packet Header Definition
    - Identification
    - TX Profile
    - Modifier
      Toggle navigation of Modifier
      - Stream 16-bit Modifier
      - Stream 32-bit Modifier
    - Stream 16-bit Modifier
    - Stream 32-bit Modifier
    - Error Handling
      Toggle navigation of Error Handling
      - Error Injection
      - Insert Frame Checksum
  - Exception
  - Enum
- Low-Level API
  Toggle navigation of Low-Level API
  - TGA & L1
    Toggle navigation of TGA & L1
    - Chassis
    - Module
    - Port
    - Stream
    - TX Statistics
    - RX Statistics
    - High-Speed Port
    - Capture
    - Histogram
    - Match Term
    - Filter
    - Length Term
    - Transceiver
    - Port Layer-1
  - L47
    Toggle navigation of L47
  - Impairment
    Toggle navigation of Impairment
Glossary of Terms

v: latest

Versions: latest; v2.5.4; v2.5.3; v2.5.1; v2.5.0-r1; v2.4.3; v2.4.0; v2.3.0; dev

Downloads: pdf; html; epub

On Read the Docs: Project Home; Builds

Back to top

Edit this page

Toggle table of contents sidebar

Capabilities & Aptitudes#

await port.aptitudes.get()
await port.capabilities.get()

Made with Furo